endpoint_base 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e259d563e2e585eb98590a759d3f62387f4a62bf
-  data.tar.gz: 914e441eca4d033b41d2ec674491d1a42294c803
+  metadata.gz: 4e46e098f78366bc2bcb2e830388d57708c4bd56
+  data.tar.gz: c42a5477374d83dec19f10575233b1c0fc495347
 SHA512:
-  metadata.gz: b9d234ca3a75ee86537058557ec0ca8ddc550d1ab32b010d45f36373343419b234359f66a94e2ea1a001fbef2456b7a35435e8ed0c146bde293b6a06260a2e20
-  data.tar.gz: afd3cc84234a6d8212fa594e5b0e56f946d45333b6ece0c3a6634239b8420f3ce01a5910ee8ddccbcc7b64637e06ad5aee8a3fb1b8f7818b265bc992f2f4a972
+  metadata.gz: 2f5b94c42940558f12c45afc4f456280e45597c02f9a3f95fb45651ea94de61986763b6a30881133e59da5c1363baf7b18793a658637d62b6203880588f0d3b7
+  data.tar.gz: c5385d32a88555300c7e4eec61027dd514ea26cf1c29215f4421f0a7aad29de49c2f049c60f6e9404020a80d7e68e8725377da8228688ebe1048627513064629

data/README.md

@@ -1,6 +1,6 @@
 # EndpointBase
 
-TODO: Write a gem description
+Shared functionality for SpreeCommerce Hub Endpoints.
 
 ## Installation
 
@@ -18,25 +18,100 @@ Or install it yourself as:
 
 ## Usage
 
+### Sinatra
+
+#### Gemfile
+
 ```ruby
-require 'endpoint_base'
+gem 'sinatra'
+gem 'tilt', '~> 1.4.1'
+gem 'tilt-jbuilder', require: 'sinatra/jbuilder'
+# ...
+gem 'endpoint_base'
+```
 
-class SampleEndpoint < EndpointBase
+#### Endpoint
 
+```ruby
+class SampleEndpoint < EndpointBase::Sinatra::Base
   post '/sample' do
-    result = { 'message_id'    => @message[:message_id],
-               'notifications' => [ { 'level'       => 'info',
-                                      'subject'     => 'New sample',
-                                      'description' => '...' } ] }
-    process_result 200, result
+    # 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: { ... } }]
+
+    # 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'
+
+    # Return a customized key and value.
+    add_value 'my_customized_key', { ... }
+
+    process_result 200
+  end
+
+  post '/fail' do
+    # Return a notification error.
+    add_notification 'error', 'Error subject', '...'
+
+    process_result 500
+  end
+end
+
+```
+
+### Rails
+
+#### Gemfile
+
+```ruby
+gem 'rails'
+# ...
+gem 'endpoint_base'
+```
+
+#### Endpoint
+
+```ruby
+class SampleController < ApplicationController
+  include EndpointBase::Concerns::All
+  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: { ... } }]
+
+    # 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'
+
+    # Return a customized key and value.
+    add_value 'my_customized_key', { ... }
+
+    process_result 200
+  end
+
+  def fail
+    # Return a notification error.
+    add_notification 'error', 'Error subject', '...'
+
+    process_result 500
   end
 end
 
 ```
 
-## Testing
+### Testing
 
-EndpointBase provides a `Controllers` testing support.
+##### spec_helper.rb
 
 ```ruby
 # ...
@@ -50,7 +125,7 @@ RSpec.configure do |config|
 end
 ```
 
-Which enables you to use `json_response` and `auth` in your Endpoint tests. It also sets `ENV['ENDPOINT_KEY'] ||= '123'`.
+`Spree:TestingSupport::Controllers` enables you to use `json_response` and `auth` in your Endpoint tests. It also sets `ENV['ENDPOINT_KEY'] ||= '123'`.
 
 ```ruby
 require 'spec_helper'
@@ -68,8 +143,8 @@ describe SampleEndpoint do
 
       expect(json_response['notifications']).to have(1).item
       expect(json_response['notifications'].first).to eq ({ 'level'       => 'info',
-                                                            'subject'     => 'New Sample',
-                                                            'description' => '...' })
+                                                            'subject'     => 'Info subject',
+                                                            'description' => 'Info description' })
     end
   end
 end

data/Rakefile

@@ -3,16 +3,16 @@ require 'bundler/gem_tasks'
 # Need to run the Rails and Sinatra specs separately so
 # their dependencies won't pollute each other.
 
-task :spec do
-  exitcode = 0
-  puts 'Running Rails specs ---------------------'
-  system 'FROM_RAKE=1 bundle exec rspec spec/rails'
-  exitcode = 1 unless $?.exitstatus == 0
+task spec: [:spec_sinatra, :spec_rails]
 
+task :spec_sinatra do
   puts 'Running Sinatra specs -------------------'
   system 'FROM_RAKE=1 bundle exec rspec spec/sinatra'
-  exitcode = 1 unless $?.exitstatus == 0
-
-  exit exitcode
+  exit exitcode unless exitcode = $?.exitstatus == 0
 end
 
+task :spec_rails do
+  puts 'Running Rails specs ---------------------'
+  system 'FROM_RAKE=1 bundle exec rspec spec/rails'
+  exit exitcode unless exitcode = $?.exitstatus == 0
+end

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

@@ -9,13 +9,5 @@ json.parameters @parameters do |parameter|
   json.value parameter[:value]
 end if @parameters.present?
 
-json.messages @messages do |message|
-  json.message message[:message]
-  json.payload message[:payload]
-end if @messages.present?
-
-json.notifications @notifications do |notification|
-  json.level         notification[:level]
-  json.subject       notification[:subject]
-  json.description   notification[:description]
-end if @notifications.present?
+json.messages      @messages      if @messages.present?
+json.notifications @notifications if @notifications.present?

data/endpoint_base.gemspec

@@ -1,15 +1,18 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
+
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require File.expand_path(File.join(File.dirname(__FILE__), %w[lib endpoint_base version]))
+
 Gem::Specification.new do |gem|
-  gem.name          = "endpoint_base"
-  gem.version       = '0.1.0'
-  gem.authors       = ["Andrew Hooker"]
-  gem.email         = ["andrew@spreecommerce.com"]
+  gem.name          = 'endpoint_base'
+  gem.version       = EndpointBase::VERSION
+  gem.authors       = ['Andrew Hooker']
+  gem.email         = ['andrew@spreecommerce.com']
   gem.description   = %q{Shared functionality for SpreeCommerce hub endpoints}
   gem.summary       = %q{SpreeCommerce hub endpoints base library}
-  gem.homepage      = "http://www.spreecommerce.com"
+  gem.homepage      = 'http://www.spreecommerce.com'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/endpoint_base/concerns/param_processor.rb

@@ -34,7 +34,7 @@ module EndpointBase::Concerns
     private
 
     def prepare_message(hsh)
-      @message = hsh.slice('message_id', 'payload')
+      @message = hsh.slice('message_id', 'message', 'payload')
     end
 
     def prepare_config(hsh)

data/lib/endpoint_base/concerns/response_dsl.rb

@@ -18,11 +18,15 @@ module EndpointBase::Concerns
         @attrs[name] = value
       end
 
-      def add_message(message, payload = {})
+      def add_message(message, payload = {}, extra = {})
         @messages ||= []
 
         @messages << { message: message,
-                       payload: payload }
+                       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)
@@ -32,12 +36,12 @@ module EndpointBase::Concerns
                          value: value }
       end
 
-      def add_notification(level, subject, description, options = {})
+      def add_notification(level, subject, description = nil, options = {})
         @notifications ||= []
 
         @notifications << { level: level,
                             subject: subject,
-                            description: description }.merge(options)
+                            description: description || subject }.merge(options)
       end
     end
   end

data/lib/endpoint_base/concerns/sinatra_responder.rb

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

data/lib/endpoint_base/version.rb

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

data/spec/sinatra/endpoint_base_spec.rb

@@ -13,6 +13,9 @@ module EndpointBase::Sinatra
     it 'accepts POST with auth' do
       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
@@ -21,6 +24,12 @@ module EndpointBase::Sinatra
       expect(last_response.location).to eq 'http://example.org/endpoint.json'
     end
 
+    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'
+    end
+
     it 'returns a 200 for /auth check' do
       get '/auth', {}, headers
       expect(last_response).to be_ok
@@ -51,5 +60,26 @@ 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
+
+        response = ::JSON.parse(last_response.body)
+
+        expect(response['messages']).to eq([{ 'message' => 'order:new', 'payload' => { 'number' => 1 } },
+                                            { 'message' => 'order:new', 'payload' => { 'number' => 2 } }])
+      end
+    end
+
+    describe '#add_notifications'do
+      it 'adds messages' do
+        post '/add_notifications', payload, headers
+
+        response = ::JSON.parse(last_response.body)
+
+        expect(response['notifications']).to eq([{ 'level' => 'error', 'subject' => 'subject', 'description' => 'description', 'backtrace' => 'backtrace' }])
+      end
+    end
   end
 end

data/spec/sinatra/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+
 SimpleCov.start do
   add_filter 'spec/spec_helper'
   add_filter 'lib/endpoint_base.rb'
@@ -20,7 +21,15 @@ require File.join(File.dirname(__FILE__), '../..', 'lib', 'endpoint_base', 'sina
 Sinatra::Base.environment = 'test'
 
 def app
-  TestEndpoint
+
+  Rack::Builder.new do
+    map '/' do
+      run TestEndpoint
+    end
+    map '/myapp' do
+      run TestEndpoint
+    end
+  end.to_app
 end
 
 RSpec.configure do |config|
@@ -30,7 +39,6 @@ end
 ENV['ENDPOINT_KEY'] = 'x123'
 
 class TestEndpoint < EndpointBase::Sinatra::Base
-
   set :logging, true
 
   post '/' do
@@ -52,4 +60,16 @@ class TestEndpoint < EndpointBase::Sinatra::Base
 
     process_result 200
   end
+
+  post '/add_messages' do
+    add_messages 'order:new', [ { number: 1 }, { number: 2 } ]
+
+    process_result 200
+  end
+
+  post '/add_notifications' do
+    add_notification 'error', 'subject', 'description', { backtrace: 'backtrace' }
+
+    process_result 200
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpoint_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Hooker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -237,7 +237,7 @@ files:
 - lib/endpoint_base/rails/engine.rb
 - lib/endpoint_base/sinatra.rb
 - lib/endpoint_base/sinatra/base.rb
-- lib/endpoint_base/sinatra/integrator_utils.rb
+- lib/endpoint_base/version.rb
 - lib/spree/testing_support/controllers.rb
 - spec/rails/controllers/failing_controller_spec.rb
 - spec/rails/controllers/happy_controller_spec.rb

data/lib/endpoint_base/sinatra/integrator_utils.rb

@@ -1,17 +0,0 @@
-module EndpointBase::Sinatra
-  module IntegratorUtils
-
-    def self.registered(app)
-
-      app.before do
-        if request.get? && request.path_info == '/'
-          redirect '/endpoint.json'
-        end
-      end
-
-    end
-
-  end
-
-  #register IntegratorUtils
-end