endpoint_base 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e46e098f78366bc2bcb2e830388d57708c4bd56
-  data.tar.gz: c42a5477374d83dec19f10575233b1c0fc495347
+  metadata.gz: da206c15c6eb0fb6f90153ea26b4b1b96c8184a8
+  data.tar.gz: 80a8882774dc330244f5211e26fc9cb365e48277
 SHA512:
-  metadata.gz: 2f5b94c42940558f12c45afc4f456280e45597c02f9a3f95fb45651ea94de61986763b6a30881133e59da5c1363baf7b18793a658637d62b6203880588f0d3b7
-  data.tar.gz: c5385d32a88555300c7e4eec61027dd514ea26cf1c29215f4421f0a7aad29de49c2f049c60f6e9404020a80d7e68e8725377da8228688ebe1048627513064629
+  metadata.gz: 94780b9489d958c57b438acffe2a58cf4b58b2143c05825e6100d17569aed7eb549441062885845b1af533b06fae3c376d152e9b05e273c51a0ff61c2b6d1ea2
+  data.tar.gz: b713616f278915b1590b161e081f3aab21d59afe706e8beb1135bc516941086770c07ecacc23ac1e7836d8d60220348a9aa79904df40282246bf435157dfcfbc

data/README.md

@@ -35,28 +35,27 @@ gem 'endpoint_base'
 ```ruby
 class SampleEndpoint < EndpointBase::Sinatra::Base
   post '/sample' do
-    # Return a message sample:new.
-    add_message 'sample:new', { sample: { ... } }
-
-    # Return a list of messages of the same type
-    add_messages 'sample:new', [{ sample: { ... } }, { sample: { ... } }]
+    # Return an order object.
+    add_object :order, { id: 1, email: 'test@example.com' }
 
     # Create or update the parameter sample.new.
     add_parameter 'sample.new', '...'
 
-    # Return a notification info. The three levels available are: info, warn and error.
-    add_notification 'info', 'Info subject', 'Info description'
+    # Set the notification summary.
+    set_summary 'The order was imported correctly'
 
     # Return a customized key and value.
     add_value 'my_customized_key', { ... }
 
+    #return the relevant HTTP status code
     process_result 200
   end
 
   post '/fail' do
-    # Return a notification error.
-    add_notification 'error', 'Error subject', '...'
+    # Set the notification summary.
+    set_summary 'The order failed to imported'
 
+    #return the relevant HTTP status code
     process_result 500
   end
 end
@@ -81,28 +80,27 @@ class SampleController < ApplicationController
   skip_before_filter :verify_authenticity_token
 
   def sample
-    # Return a message sample:new.
-    add_message 'sample:new', { sample: { ... } }
-
-    # Return a list of messages of the same type
-    add_messages 'sample:new', [{ sample: { ... } }, { sample: { ... } }]
+    # Return an order object.
+    add_object :order, { id: 1, email: 'test@example.com' }
 
     # Create or update the parameter sample.new.
     add_parameter 'sample.new', '...'
 
-    # Return a notification info. The three levels available are: info, warn and error.
-    add_notification 'info', 'Info subject', 'Info description'
+    # Set the notification summary.
+    set_summary 'The order was imported correctly'
 
     # Return a customized key and value.
     add_value 'my_customized_key', { ... }
 
+    #return the relevant HTTP status code
     process_result 200
   end
 
   def fail
-    # Return a notification error.
-    add_notification 'error', 'Error subject', '...'
+    # Set the notification summary.
+    set_summary 'The order failed to imported'
 
+    #return the relevant HTTP status code
     process_result 500
   end
 end
@@ -131,9 +129,9 @@ end
 require 'spec_helper'
 
 describe SampleEndpoint do
-  let(:request) { { message: 'sample:new',
-                    message_id: '1234567',
-                    payload: { parameters: [] } } }
+  let(:request) { { request_id: '1234567',
+                    order: {},
+                    parameters: []  } }
 
   describe '/sample' do
     it 'notifies a new sample' do
@@ -141,10 +139,7 @@ describe SampleEndpoint do
 
       expect(last_response).to be_ok
 
-      expect(json_response['notifications']).to have(1).item
-      expect(json_response['notifications'].first).to eq ({ 'level'       => 'info',
-                                                            'subject'     => 'Info subject',
-                                                            'description' => 'Info description' })
+      expect(json_response['summary']).to eq "Order was successfully imported"
     end
   end
 end

data/app/views/application/500.json.jbuilder

@@ -1,2 +1,2 @@
-json.message_id @message['message_id']
-json.error error
+json.request_id @payload['request_id']
+json.summary error

data/app/views/application/response.json.jbuilder

@@ -1,13 +1,15 @@
-json.message_id @message['message_id']
+json.request_id @payload['request_id']
 
 @attrs.each do |name, value|
   json.set! name, value
 end if @attrs.present?
 
-json.parameters @parameters do |parameter|
-  json.name  parameter[:name]
-  json.value parameter[:value]
+json.set! :parameters do
+  @parameters.each do |key, value|
+    json.set! key.to_sym, value
+  end
 end if @parameters.present?
 
-json.messages      @messages      if @messages.present?
-json.notifications @notifications if @notifications.present?
+@objects.each do |klass, objects|
+  json.set! klass, objects
+end if @objects.present?

data/lib/endpoint_base/concerns/param_processor.rb

@@ -9,7 +9,7 @@ module EndpointBase::Concerns
         helper Helpers
 
         before_action do
-          prepare_message params
+          prepare_payload params
           prepare_config params
         end
 
@@ -24,7 +24,7 @@ module EndpointBase::Concerns
               halt 406
             end
 
-            prepare_message parsed
+            prepare_payload parsed
             prepare_config parsed
           end
         end
@@ -33,16 +33,18 @@ module EndpointBase::Concerns
 
     private
 
-    def prepare_message(hsh)
-      @message = hsh.slice('message_id', 'message', 'payload')
+    def prepare_payload(hsh)
+      @payload = hsh
     end
 
     def prepare_config(hsh)
-      @config = hsh[:payload]['parameters'] || []
-      @config = @config.inject({}) do |result, param|
-        result[param[:name]] = param[:value]
-        result
+      if hsh.key? 'parameters'
+        if hsh['parameters'].is_a? Hash
+          @config = hsh['parameters']
+        end
       end
+
+      @config || {}
     end
 
     module Helpers

data/lib/endpoint_base/concerns/response_dsl.rb

@@ -18,30 +18,19 @@ module EndpointBase::Concerns
         @attrs[name] = value
       end
 
-      def add_message(message, payload = {}, extra = {})
-        @messages ||= []
-
-        @messages << { message: message,
-                       payload: payload }.merge(extra)
-      end
-
-      def add_messages(message, collection, extra = {})
-        collection.each { |payload| add_message(message, payload, extra) }
-      end
-
       def add_parameter(name, value)
-        @parameters ||= []
+        @parameters ||= {}
 
-        @parameters << { name: name,
-                         value: value }
+        @parameters[name] = value
       end
 
-      def add_notification(level, subject, description = nil, options = {})
-        @notifications ||= []
+      def set_summary(summary)
+        add_value(:summary, summary)
+      end
 
-        @notifications << { level: level,
-                            subject: subject,
-                            description: description || subject }.merge(options)
+      def add_object(klass, object)
+        @objects ||= Hash.new {|h,k| h[k] = []}
+        @objects[klass.to_s.pluralize] << object
       end
     end
   end

data/lib/endpoint_base/concerns/sinatra_responder.rb

@@ -8,14 +8,6 @@ module EndpointBase::Concerns
       elsif EndpointBase.sinatra?
         helpers Helpers
 
-        set :public_folder, './public'
-
-        before do
-          if request.get? && request.path_info == '/'
-            redirect "#{request.script_name}/endpoint.json"
-          end
-        end
-
         get '/auth' do
           status 200
         end

data/lib/endpoint_base/concerns/token_authorization.rb

@@ -13,7 +13,7 @@ module EndpointBase::Concerns
     private
 
     def authorize_rails
-      unless request.headers["HTTP_X_AUGURY_TOKEN"] == ENV['ENDPOINT_KEY']
+      unless request.headers["HTTP_X_HUB_TOKEN"] == ENV['ENDPOINT_KEY']
         render status: 401, json: {text: 'unauthorized'}
         return false
       end
@@ -21,7 +21,7 @@ module EndpointBase::Concerns
 
     def authorize_sinatra
       return unless request.post?
-      halt 401 if request.env["HTTP_X_AUGURY_TOKEN"] != ENV['ENDPOINT_KEY']
+      halt 401 if request.env["HTTP_X_HUB_TOKEN"] != ENV['ENDPOINT_KEY']
     end
 
   end

data/lib/endpoint_base/sinatra.rb

@@ -1,2 +1,3 @@
 require 'sinatra/jbuilder'
 require 'endpoint_base/sinatra/base'
+#require 'active_support/core_ext/string/conversions'

data/lib/endpoint_base/version.rb

@@ -1,3 +1,3 @@
 module EndpointBase
-  VERSION = '0.1.1'
+  VERSION = '0.2'
 end

data/lib/spree/testing_support/controllers.rb

@@ -4,7 +4,7 @@ module Spree
       ENV['ENDPOINT_KEY'] ||= '123'
 
       def auth
-        { 'HTTP_X_AUGURY_TOKEN' => ENV['ENDPOINT_KEY'], 'CONTENT_TYPE' => 'application/json' }
+        { 'HTTP_X_HUB_TOKEN' => ENV['ENDPOINT_KEY'], 'CONTENT_TYPE' => 'application/json' }
       end
 
       def json_response

data/spec/rails/controllers/failing_controller_spec.rb

@@ -7,20 +7,20 @@ describe FailingController, type: 'controller' do
                   { 'name' => 'spree.api_version', 'value' => '2.0' }] }
 
   let(:message) {{ 'store_id' => '123229227575e4645c000001',
-                   'message_id' => 'abc',
-                   'payload' => { 'parameters' => config } }}
+                   'request_id' => 'abc',
+                   'parameters' => config }}
 
 
   it "renders the 500.json page on exceptions" do
     post :index, message
 
     response.code.should eq '500'
-    json_response['error'].should eq 'I see dead people'
-    json_response['message_id'].should eq 'abc'
+    json_response['summary'].should eq 'I see dead people'
+    json_response['request_id'].should eq 'abc'
   end
 
   it "return 401 on authorization failues" do
-    request.env['HTTP_X_AUGURY_TOKEN'] = 'wrong'
+    request.env['HTTP_X_HUB_TOKEN'] = 'wrong'
     post :index, message
 
     response.code.should eq '401'

data/spec/rails/controllers/happy_controller_spec.rb

@@ -7,8 +7,8 @@ describe HappyController, type: 'controller' do
                   { 'name' => 'spree.api_version', 'value' => '2.0' }] }
 
   let(:message) {{ 'store_id' => '123229227575e4645c000001',
-                   'message_id' => 'abc',
-                   'payload' => { 'parameters' => config } }}
+                   'requet_id' => 'abc',
+                   'parameters' => config }}
 
 
   it 'render populated response' do
@@ -16,20 +16,12 @@ describe HappyController, type: 'controller' do
 
     response.code.should eq '200'
 
-    json_response['messages'].size.should == 1
-    msg = json_response['messages'].first
-    msg['message'].should == 'spree:order:poll'
-    msg['payload'].should == {}
-
-    json_response['parameters'].size.should == 2
-    param =  json_response['parameters'].first
-    param['name'].should == 'spree.order_poll.last_updated_at'
-    param['value'].should  == 'today'
-
-    json_response['notifications'].size.should == 1
-    note = json_response['notifications'].first
-    note['level'].should == 'info'
-    note['subject'].should  == 'hello world'
-    note['description'].should  == 'today is a good day to ...'
+    json_response['products'].size.should == 1
+    product = json_response['products'].first
+    product['id'].should == 1
+
+    json_response['parameters']['spree.order_poll.last_updated_at'].should  == 'today'
+
+    json_response['summary'].should  == 'today is a good day to ...'
   end
 end

data/spec/rails/dummy/app/controllers/happy_controller.rb

@@ -2,12 +2,11 @@ class HappyController < ApplicationController
   include EndpointBase::Concerns::All
 
   def index
-    add_message 'spree:order:poll'
+    add_object :product, { id: 1, name: 'Test Product' }
     add_parameter 'spree.order_poll.last_updated_at', 'today'
     add_parameter 'spree.order_poll.first_updated_at', 'yesterday'
-    add_notification 'info', 'hello world', 'today is a good day to ...'
+    set_summary 'today is a good day to ...'
 
     process_result 200
   end
 end
-

data/spec/rails/support/controllers.rb

@@ -3,7 +3,7 @@ module Controllers
     mod.before do
       request.env["HTTP_ACCEPT"] = "application/json"
       request.env["CONTENT_TYPE"] = "application/json"
-      request.env["HTTP_X_AUGURY_TOKEN"] = "x123"
+      request.env["HTTP_X_HUB_TOKEN"] = "x123"
     end
   end
 

data/spec/sinatra/endpoint_base_spec.rb

@@ -2,8 +2,8 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 
 module EndpointBase::Sinatra
   describe Base do
-    let(:payload) { { :message_id => 'abc456', :payload => {} }.to_json }
-    let(:headers) { {'HTTP_X_AUGURY_TOKEN' => 'x123', "CONTENT_TYPE" => "application/json"} }
+    let(:payload) { { :request_id => 'abc456', :order => {id: 'R123'} }.to_json }
+    let(:headers) { {'HTTP_X_HUB_TOKEN' => 'x123', "CONTENT_TYPE" => "application/json"} }
 
     it 'rejects request without auth' do
       post '/', payload
@@ -14,20 +14,10 @@ module EndpointBase::Sinatra
       post '/', payload, headers
       expect(last_response).to be_ok
 
-      expect(::JSON.parse(last_response.body)['notifications']).to be_nil
-      expect(::JSON.parse(last_response.body)['messages']).to be_nil
-    end
-
-    it 'redirects to endpoint.json for GET on root url' do
-      get '/', nil, {}
-      expect(last_response.status).to eq 302
-      expect(last_response.location).to eq 'http://example.org/endpoint.json'
-    end
+      response = ::JSON.parse(last_response.body)
 
-    it 'redirect to relative root endpoint.json for GET on mapped root url' do
-      get '/myapp/', nil, {}
-      expect(last_response.status).to eq 302
-      expect(last_response.location).to eq 'http://example.org/myapp/endpoint.json'
+      expect(response['orders']).to be_nil
+      expect(response['request_id']).to eq 'abc456'
     end
 
     it 'returns a 200 for /auth check' do
@@ -47,7 +37,7 @@ module EndpointBase::Sinatra
     end
 
     it 'finds parameters' do
-      body = { 'payload' => { 'parameters' => [{'name' => 'x', 'value' => 1}, {'name' => '2', 'value' => 3}] } }.to_json
+      body = { 'parameters' => {'x' => 1, '2' => 3} }.to_json
       post '/config', body, headers
 
       response = ::JSON.parse(last_response.body)['params']
@@ -61,25 +51,30 @@ module EndpointBase::Sinatra
       expect(last_response.content_type).to eq 'application/json;charset=utf-8'
     end
 
-    describe '#add_messages' do
-      it 'adds messages' do
-        post '/add_messages', payload, headers
+    describe '#add_objects' do
+      it 'adds objects' do
+        post '/add_objects', payload, headers
 
         response = ::JSON.parse(last_response.body)
 
-        expect(response['messages']).to eq([{ 'message' => 'order:new', 'payload' => { 'number' => 1 } },
-                                            { 'message' => 'order:new', 'payload' => { 'number' => 2 } }])
+        expect(response['orders']).to eq([{ 'id' => 1, 'email' => 'test@example.com' },
+                                                     { 'id' => 2, 'email' => 'spree@example.com' }])
+        expect(response['products']).to eq([{ 'id' => 1, 'sku' => 'ROR-123' }])
       end
     end
 
-    describe '#add_notifications'do
-      it 'adds messages' do
-        post '/add_notifications', payload, headers
+    it 'returns parameters set' do
+      post '/add_parameter', payload, headers
 
-        response = ::JSON.parse(last_response.body)
+      response = ::JSON.parse(last_response.body)
+      expect(response['parameters']['some.param']).to eq 123
+    end
 
-        expect(response['notifications']).to eq([{ 'level' => 'error', 'subject' => 'subject', 'description' => 'description', 'backtrace' => 'backtrace' }])
-      end
+    it 'sets the summary' do
+      post '/set_summary', payload, headers
+
+      response = ::JSON.parse(last_response.body)
+      expect(response['summary']).to eq 'everything is ok'
     end
   end
 end

data/spec/sinatra/spec_helper.rb

@@ -45,30 +45,41 @@ class TestEndpoint < EndpointBase::Sinatra::Base
     process_result 200
   end
 
+  #used to verify JSON parsing in param_processor
   post '/payload' do
-    add_value :payload, @message[:payload]
+    @payload.to_json
+  end
+
+  #used to verify parameters are correctly stored in @config
+  post '/config' do
+    add_value :params, @config
 
     process_result 200
   end
 
-  post '/deprecated' do
-    process_result 200, @message
+  post '/add_value' do
+    add_value :priates, [  { id: 5, name: 'Blue Beard'},
+                           { id: 7, name: 'Peg Eye' } ]
+
+    process_result 200
   end
 
-  post '/config' do
-    add_value :params, @config
+  post '/add_objects' do
+    add_object :order, { id: 1, email: 'test@example.com' }
+    add_object :order, { id: 2, email: 'spree@example.com' }
+    add_object :product, { id: 1, sku: 'ROR-123' }
 
     process_result 200
   end
 
-  post '/add_messages' do
-    add_messages 'order:new', [ { number: 1 }, { number: 2 } ]
+  post '/add_parameter' do
+    add_parameter 'some.param', 123
 
     process_result 200
   end
 
-  post '/add_notifications' do
-    add_notification 'error', 'subject', 'description', { backtrace: 'backtrace' }
+  post '/set_summary' do
+    set_summary 'everything is ok'
 
     process_result 200
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpoint_base
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Andrew Hooker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json