konekt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 716e607b786f4ee9afcdbb63571a53241765aed4
+  data.tar.gz: 4d198b49d12b58d74ea46fda61cd3ff73b31b1f9
+SHA512:
+  metadata.gz: aaed9cae72fd76165fa284b048f7356503d4ac0c0663d626d593c8cca5d962d5eb5e1bd907e42e5801811810ceec7dcbd1c26b80bfd3147d77e33c44cd496339
+  data.tar.gz: da212237f49af87e37e8c1f25c5426b8af036ea34d22419c3c07e1ddaeca4d097c303c1bcac298f376284a7b8e59c6f6918c2f7651a85ffb3c76ce0a9c7aa661

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in konket.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Robert Coleman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Konekt
+
+A Ruby (and optionally Rails) library to interact with the Konekt cloud.
+
+Current features:
+
+* Webhook to receive messages - "Custom Webhook Url (your own App)"
+  * Automatic authentication to webhook key
+  * Decodes payload JSON
+  * Decodes data base64
+  * Basically, all data passed in to Konekt is passed out as an easy to consume object - per tag, where ever in your app you wish to subscribe.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'konekt'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install konekt`
+
+#### Setup
+
+The endpoint defaults to '/konekt_processor'. If you're app is at `https://example.com/` then you should set your webhook URL in Konekt to `https://example.com/konekt_processor`
+
+`ENV['KONEKT_WEBHOOK_KEY']` should be set to to the "Webhook Key" value from the Konekt _applcation_ for this webhook.
+
+Or you can override these in configuration:
+
+```ruby
+  # In an appropriate initializer
+  Konekt.configure do |config|
+    config.mount_point = '/some/other/path'
+    config.auth_token = ENV['KONEKT_WEBHOOK_KEY']
+  end
+```
+
+__Rack/Sinatra:__
+
+```ruby
+  # config.ru
+  require 'konekt/middleware'
+  use Konekt::Middleware
+```
+
+__Rails:__ This middleware is registered automatically.
+
+
+### Subscribing to Tags
+
+Subscribe to the tags you care about:
+
+```ruby
+Konekt.subscribe 'parcel_shipped' do |event|
+  puts event
+  # Do something with event
+  # You probably want to fire a background task
+end
+```
+
+In Rails this could live at `config/initalizers/konekt.rb`
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/konekt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'konekt'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/konekt.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'konekt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'konekt'
+  spec.version       = Konekt::VERSION
+  spec.authors       = ['Robert Coleman']
+  spec.email         = ['github@robert.net.nz']
+
+  spec.summary       = %q{A Ruby library to interact with Konekt Cloud via Ruby and Rails.}
+  spec.description   = %q{A Ruby library to interact with Konekt Cloud via Ruby and Rails.}
+  spec.homepage      = 'https://github.com/rjocoleman/konekt'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',   '~> 1.8'
+  spec.add_development_dependency 'rake',      '~> 10.0'
+  spec.add_development_dependency 'pry',       '~> 0.10'
+  spec.add_development_dependency 'rspec',     '~> 3.3'
+  spec.add_development_dependency 'rack-test', '~> 0.6'
+end

data/lib/konekt.rb

@@ -0,0 +1,6 @@
+require 'logger'
+
+require 'konekt/version'
+require 'konekt/configuration'
+require 'konekt/listeners'
+require 'konekt/railtie' if defined?(Rails::Railtie)

data/lib/konekt/configuration.rb

@@ -0,0 +1,33 @@
+module Konekt
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor *[
+      :logger,
+      :mount_point,
+      :auth_token,
+      :raise_exceptions,
+    ]
+
+    alias_method :raise_exceptions?, :raise_exceptions
+
+    def initialize
+      @mount_point      = '/konekt_processor'
+      @logger           = Logger.new STDOUT
+      @auth_token       = ENV['KONEKT_WEBHOOK_KEY']
+      @raise_exceptions = true unless ENV['RACK_ENV'] == 'production'
+    end
+
+  end
+end

data/lib/konekt/event.rb

@@ -0,0 +1,56 @@
+require 'json'
+require 'base64'
+
+module Konekt
+  class Event
+    class InvalidEventData < StandardError; end
+
+    attr_reader *[
+      :tags,
+      :data,
+      :received_at,
+      :source,
+      :device_name,
+      :user_id,
+      :payload,
+      :properties
+    ]
+
+    def self.from_params(params)
+      attrs       = JSON.parse params['payload']
+      tags        = attrs.fetch('tags')
+      data        = Base64.decode64(attrs.fetch('data'))
+      received_at = Time.parse(attrs.fetch('received'))
+      source      = attrs.fetch('source')
+      device_name = attrs.fetch('device_name')
+      user_id     = params['userid']
+      properties  = JSON.parse params['properties']
+
+      event = { tags: tags,
+        data: data,
+        received_at: received_at,
+        source: source,
+        device_name: device_name,
+        user_id: user_id,
+        payload: attrs,
+        properties: properties,
+      }
+      new event
+
+    rescue ArgumentError, KeyError, JSON::JSONError => e
+      raise InvalidEventData, e
+    end
+
+    def initialize(opts={})
+      @tags = opts[:tags]
+      @data = opts[:data]
+      @received_at = opts[:received_at] || Time.now.utc
+      @source = opts[:source]
+      @device_name = opts[:device_name]
+      @user_id = opts[:user_id]
+      @payload = opts[:payload]
+      @properties = opts[:properties]
+    end
+
+  end
+end

data/lib/konekt/listeners.rb

@@ -0,0 +1,15 @@
+module Konekt
+  LISTENERS = Hash.new
+
+  def self.subscribe(event_tag, &block)
+    LISTENERS[event_tag] ||= []
+    LISTENERS[event_tag] << block
+  end
+
+  def self.propagate(event)
+    event.tags.each do |tag|
+      Array(LISTENERS[tag]).each { |block| block.call event }
+    end
+  end
+
+end

data/lib/konekt/middleware.rb

@@ -0,0 +1,48 @@
+require 'konekt/configuration'
+require 'konekt/event'
+require 'konekt/listeners'
+
+module Konekt
+  class Middleware
+
+    def initialize(app=nil)
+      @app = app
+    end
+
+    def config
+      Konekt.configuration
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      return @app.call(env) unless req.path_info == config.mount_point
+      return response 405 unless req.post?
+      return response 403 unless req.params['key'] == config.auth_token
+
+      parse_and_respond req.params
+    end
+
+  private
+
+    def parse_and_respond(params)
+      event = Event.from_params params
+      Konekt.propagate event
+      response 200, 'ACK'
+    rescue Event::InvalidEventData => e
+      config.logger.error e
+      response 200, 'Ignored invalid event'
+    rescue => e
+      raise e if config.raise_exceptions?
+      response 500, 'NAK'
+    end
+
+    def response(status, body='', headers={})
+      [
+        status,
+        {'Content-Type' => 'text/plain'}.merge(headers),
+        [body],
+      ]
+    end
+
+  end
+end

data/lib/konekt/railtie.rb

@@ -0,0 +1,11 @@
+require 'konekt/middleware'
+
+module Konekt
+  class Railtie < Rails::Railtie
+
+    initializer 'konekt.use_rack_middleware' do |app|
+      app.config.middleware.use 'Konekt::Middleware'
+    end
+
+  end
+end

data/lib/konekt/version.rb

@@ -0,0 +1,3 @@
+module Konekt
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: konekt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A Ruby library to interact with Konekt Cloud via Ruby and Rails.
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- konekt.gemspec
+- lib/konekt.rb
+- lib/konekt/configuration.rb
+- lib/konekt/event.rb
+- lib/konekt/listeners.rb
+- lib/konekt/middleware.rb
+- lib/konekt/railtie.rb
+- lib/konekt/version.rb
+homepage: https://github.com/rjocoleman/konekt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby library to interact with Konekt Cloud via Ruby and Rails.
+test_files: []