endpoint_base 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 534fad9f53890503329c7a8da7faa1c4ffa934a9
+  data.tar.gz: 64588c322e901dead79193836ad83079f64cf3df
+SHA512:
+  metadata.gz: 6933b9113d0214114c308b7bcc4769107b9fe44088bdd1adab65f82e7efe76719c916d733f6d4a221c0e4fd1e1391854c1c73519e1b23d1b1a55fb6977b415cd
+  data.tar.gz: 33a94a1b4c1cdaed3369b1e39fe4190e0dfa700ac5fc1f979dc91de441832351483d9d63f4af69d21ebb0b69705bd961215885cde9752b2ed9c77086e6e601dc

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock
+*.swo
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec rspec"
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  email:
+    - brian@spreecommerce.com

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Hooker
+
+MIT License
+
+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,84 @@
+# EndpointBase
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'endpoint_base'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install endpoint_base
+
+## Usage
+
+```ruby
+require 'endpoint_base'
+
+class SampleEndpoint < EndpointBase
+
+  post '/sample' do
+    result = { 'message_id'    => @message[:message_id],
+               'notifications' => [ { 'level'       => 'info',
+                                      'subject'     => 'New sample',
+                                      'description' => '...' } ] }
+    process_result 200, result
+  end
+end
+
+```
+
+## Testing
+
+EndpointBase provides a `Controllers` testing support.
+
+```ruby
+# ...
+require 'spree/testing_support/controllers'
+
+# ...
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.include Spree::TestingSupport::Controllers
+end
+```
+
+Which enables you to use `json_response` and `auth` in your Endpoint tests. It also sets `ENV['ENDPOINT_KEY'] ||= '123'`.
+
+```ruby
+require 'spec_helper'
+
+describe SampleEndpoint do
+  let(:request) { { message: 'sample:new',
+                    message_id: '1234567',
+                    payload: { parameters: [] } } }
+
+  describe '/sample' do
+    it 'notifies a new sample' do
+      post '/sample', request.to_json, auth
+
+      expect(last_response).to be_ok
+
+      expect(json_response['notifications']).to have(1).item
+      expect(json_response['notifications'].first).to eq ({ 'level'       => 'info',
+                                                            'subject'     => 'New Sample',
+                                                            'description' => '...' })
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/endpoint_base.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "endpoint_base"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Andrew Hooker"]
+  gem.email         = ["andrew@spreecommerce.com"]
+  gem.description   = %q{Shared functionality for spree professional endpoints}
+  gem.summary       = %q{Spree Endpoints}
+  gem.homepage      = "http://www.spreecommerce.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'sinatra', '1.4.3'
+  gem.add_dependency 'sinatra-contrib'
+  gem.add_dependency 'json'
+  gem.add_dependency 'activesupport'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'vcr'
+end
+

data/lib/cross_origin.rb

@@ -0,0 +1,49 @@
+require 'sinatra/base'
+
+module Sinatra
+  module CrossOrigin
+    module Helpers
+
+      # Apply cross origin headers either
+      # from global config or custom config passed
+      # as a hash
+      def cross_origin(hash=nil)
+        return unless request.env['HTTP_ORIGIN']
+        settings.set hash if hash
+
+        origin = settings.allow_origin == :any ? request.env['HTTP_ORIGIN'] : settings.allow_origin
+        methods = settings.allow_methods.map{ |m| m.to_s.upcase! }.join(', ')
+
+        headers_list = {
+          'Access-Control-Allow-Origin' => origin,
+          'Access-Control-Allow-Methods' => methods,
+          'Access-Control-Allow-Headers' => settings.allow_headers.map(&:to_s).join(', '),
+          'Access-Control-Allow-Credentials' => settings.allow_credentials.to_s,
+          'Access-Control-Max-Age' => settings.max_age.to_s
+        }
+
+        headers headers_list
+      end
+    end
+
+    def self.registered(app)
+
+      app.helpers CrossOrigin::Helpers
+
+      app.set :cross_origin, false
+      app.set :allow_origin, :any
+      app.set :allow_methods, [:post, :get, :options]
+      app.set :allow_credentials, true
+      app.set :allow_headers, ["*", "Content-Type", "Accept", "AUTHORIZATION", "Cache-Control"]
+      app.set :max_age, 1728000
+
+      app.before do
+        cross_origin if settings.cross_origin
+      end
+
+    end
+  end
+
+  register CrossOrigin
+
+end

data/lib/endpoint_base.rb

@@ -0,0 +1,13 @@
+require 'sinatra'
+require 'integrator_utils'
+require 'cross_origin'
+
+class EndpointBase < Sinatra::Base
+  register Sinatra::IntegratorUtils
+  register Sinatra::CrossOrigin
+
+  configure do
+    enable :cross_origin
+  end
+end
+

data/lib/integrator_utils.rb

@@ -0,0 +1,58 @@
+require 'sinatra/base'
+require 'sinatra/json'
+require 'json'
+require 'active_support/core_ext/hash'
+require 'multi_json'
+
+module Sinatra
+  module IntegratorUtils
+
+    module Helpers
+      def config(message)
+        conf = message[:payload]['parameters'] || []
+
+        conf.inject(HashWithIndifferentAccess.new) do |result, param|
+          result[param[:name]] = param[:value]
+          result
+        end
+      end
+
+      def process_result(code, response)
+        status code
+        json response
+      end
+    end
+
+    def self.registered(app)
+
+      app.helpers Sinatra::JSON
+      app.helpers IntegratorUtils::Helpers
+
+      app.set :public_folder, './public'
+
+      app.before do
+        if request.get? && request.path_info == '/'
+          redirect '/endpoint.json'
+        else
+          halt 401 if request.env["HTTP_X_AUGURY_TOKEN"] != ENV['ENDPOINT_KEY']
+        end
+
+        if request.post?
+          begin
+            @message = ::JSON.parse(request.body.read).with_indifferent_access
+            @config = config(@message)
+          rescue Exception => e
+            halt 406
+          end
+        end
+      end
+
+      app.get '/auth' do
+        status 200
+      end
+    end
+
+  end
+
+  register IntegratorUtils
+end

data/lib/spree/testing_support/controllers.rb

@@ -0,0 +1,20 @@
+module Spree
+  module TestingSupport
+    module Controllers
+      ENV['ENDPOINT_KEY'] ||= '123'
+
+      def auth
+        { 'HTTP_X_AUGURY_TOKEN' => ENV['ENDPOINT_KEY'], 'CONTENT_TYPE' => 'application/json' }
+      end
+
+      def json_response
+        @json_response ||= JSON.parse(last_response.body)
+      end
+
+      def app
+        described_class
+      end
+    end
+  end
+end
+

data/spec/cross_origin_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Sinatra
+  describe CrossOrigin do
+    let(:payload) { {:payload => {} }.to_json }
+    let(:headers) { {'HTTP_X_AUGURY_TOKEN' => 'x123', "CONTENT_TYPE" => "application/json", 'HTTP_ORIGIN' => 'http://spreecommerce.com'} }
+
+    it "should include CORS headers when ORIGIN is specified" do
+      post '/', payload, headers
+      last_response.headers['Access-Control-Allow-Origin'].should == 'http://spreecommerce.com'
+    end
+
+    it "should not include CORS headers when ORIGIN is not specified" do
+      headers.delete('HTTP_ORIGIN')
+      post '/', payload, headers
+      last_response.headers['Access-Control-Allow-Origin'].should be_nil
+    end
+
+  end
+end

data/spec/integrator_utils_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Sinatra
+  describe IntegratorUtils do
+    let(:payload) { {:payload => {} }.to_json }
+    let(:headers) { {'HTTP_X_AUGURY_TOKEN' => 'x123', "CONTENT_TYPE" => "application/json"} }
+
+    it "should reject request without auth" do
+      post '/', payload
+      last_response.status.should == 401
+    end
+
+    it "should accept POST with auth" do
+      post '/', payload, headers
+      last_response.status.should == 200
+    end
+
+    it "should redirect to endpoint.json for GET on root url" do
+      get '/', nil, {}
+      last_response.status.should == 302
+      last_response.location.should == 'http://example.org/endpoint.json'
+    end
+
+    it 'returns a 200 for /auth check' do
+      get '/auth', {}, headers
+      last_response.status.should == 200
+    end
+
+    it "should parse valid json from body" do
+      post '/', {payload: {}, test: [{"west" => 1}, {"south" => false}]}.to_json, headers
+      msg = ::JSON.parse(last_response.body)
+      msg['test'].size.should == 2
+      msg['test'].first['west'].should == 1
+      msg['test'].last[:south].should be_false
+    end
+
+    it "should return 406 if body is not valid json" do
+      post '/', 'notjson', headers
+      last_response.status.should == 406
+    end
+
+    it "should find parameters" do
+      body = { 'payload' => { 'parameters' => [{'name' => 'x', 'value' => 1}, {'name' => '2', 'value' => 3}] } }.to_json
+      post '/config', body, headers
+
+      response = ::JSON.parse(last_response.body)
+      response['x'].should == 1
+      response['2'].should == 3
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'bundler'
+require 'vcr'
+
+Bundler.require(:default, :test)
+require 'rack/test'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'endpoint_base.rb')
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+Sinatra::Base.environment = 'test'
+
+def app
+  TestEndpoint
+end
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+end
+
+ENV['ENDPOINT_KEY'] = 'x123'
+
+class TestEndpoint < EndpointBase
+
+  set :logging, true
+
+  post '/' do
+    process_result(200, @message)
+  end
+
+  post '/config' do
+    process_result(200, config(@message))
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: endpoint_base
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Hooker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shared functionality for spree professional endpoints
+email:
+- andrew@spreecommerce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- endpoint_base.gemspec
+- lib/cross_origin.rb
+- lib/endpoint_base.rb
+- lib/integrator_utils.rb
+- lib/spree/testing_support/controllers.rb
+- spec/cross_origin_spec.rb
+- spec/integrator_utils_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.spreecommerce.com
+licenses: []
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Spree Endpoints
+test_files:
+- spec/cross_origin_spec.rb
+- spec/integrator_utils_spec.rb
+- spec/spec_helper.rb