endpoint_base 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 534fad9f53890503329c7a8da7faa1c4ffa934a9
-  data.tar.gz: 64588c322e901dead79193836ad83079f64cf3df
+  metadata.gz: e259d563e2e585eb98590a759d3f62387f4a62bf
+  data.tar.gz: 914e441eca4d033b41d2ec674491d1a42294c803
 SHA512:
-  metadata.gz: 6933b9113d0214114c308b7bcc4769107b9fe44088bdd1adab65f82e7efe76719c916d733f6d4a221c0e4fd1e1391854c1c73519e1b23d1b1a55fb6977b415cd
-  data.tar.gz: 33a94a1b4c1cdaed3369b1e39fe4190e0dfa700ac5fc1f979dc91de441832351483d9d63f4af69d21ebb0b69705bd961215885cde9752b2ed9c77086e6e601dc
+  metadata.gz: b9d234ca3a75ee86537058557ec0ca8ddc550d1ab32b010d45f36373343419b234359f66a94e2ea1a001fbef2456b7a35435e8ed0c146bde293b6a06260a2e20
+  data.tar.gz: afd3cc84234a6d8212fa594e5b0e56f946d45333b6ece0c3a6634239b8420f3ce01a5910ee8ddccbcc7b64637e06ad5aee8a3fb1b8f7818b265bc992f2f4a972

data/.gitignore

@@ -17,3 +17,4 @@ tmp
 Gemfile.lock
 *.swo
 *.swp
+.DS_Store

data/.travis.yml

@@ -1,6 +1,5 @@
-script: "bundle exec rspec"
+script: "bundle exec rake spec"
 rvm:
-  - 1.9.3
   - 2.0.0
 notifications:
   email:

data/Rakefile

@@ -1 +1,18 @@
-require "bundler/gem_tasks"
+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
+
+  puts 'Running Sinatra specs -------------------'
+  system 'FROM_RAKE=1 bundle exec rspec spec/sinatra'
+  exitcode = 1 unless $?.exitstatus == 0
+
+  exit exitcode
+end
+

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

@@ -0,0 +1,2 @@
+json.message_id @message['message_id']
+json.error error

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

@@ -0,0 +1,21 @@
+json.message_id @message['message_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]
+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?

data/endpoint_base.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "endpoint_base"
-  gem.version       = '0.0.1'
+  gem.version       = '0.1.0'
   gem.authors       = ["Andrew Hooker"]
   gem.email         = ["andrew@spreecommerce.com"]
-  gem.description   = %q{Shared functionality for spree professional endpoints}
-  gem.summary       = %q{Spree Endpoints}
+  gem.description   = %q{Shared functionality for SpreeCommerce hub endpoints}
+  gem.summary       = %q{SpreeCommerce hub endpoints base library}
   gem.homepage      = "http://www.spreecommerce.com"
 
   gem.files         = `git ls-files`.split($/)
@@ -16,14 +16,25 @@ Gem::Specification.new do |gem|
   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 'jbuilder'
   gem.add_dependency 'activesupport'
 
+  #sinatra
+  gem.add_development_dependency 'sinatra', '1.4.3'
+  gem.add_development_dependency 'sinatra-contrib'
+  gem.add_development_dependency 'tilt-jbuilder'
+  gem.add_development_dependency 'rack-test'
+
+  #rails
+  gem.add_development_dependency 'rails', "~> 4.0.0"
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'sqlite3'
+
+  #dev
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'rack-test'
   gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'simplecov'
 end
 

data/lib/endpoint_base.rb

@@ -1,13 +1,34 @@
-require 'sinatra'
-require 'integrator_utils'
-require 'cross_origin'
+module EndpointBase
+  def self.framework
+    if defined?(Rails)
+      :rails
+    elsif defined?(Sinatra)
+      :sinatra
+    end
+  end
+
+  def self.rails?
+    self.framework == :rails
+  end
 
-class EndpointBase < Sinatra::Base
-  register Sinatra::IntegratorUtils
-  register Sinatra::CrossOrigin
+  def self.sinatra?
+    self.framework == :sinatra
+  end
 
-  configure do
-    enable :cross_origin
+  def self.path_to_views
+    File.expand_path("../app/views", File.dirname(__FILE__))
   end
 end
 
+require 'active_support'
+require 'endpoint_base/concerns'
+
+if EndpointBase.rails?
+  require 'endpoint_base/rails'
+  require 'jbuilder'
+elsif EndpointBase.sinatra?
+  require 'endpoint_base/sinatra'
+else
+  puts '[Endpoint Base] Neither Rails or Sinatra are defined, you must manually require the relevant endpoint_base files.'
+end
+

data/lib/endpoint_base/concerns.rb

@@ -0,0 +1,7 @@
+require 'endpoint_base/concerns/param_processor'
+require 'endpoint_base/concerns/response_dsl'
+require 'endpoint_base/concerns/exception_handler'
+require 'endpoint_base/concerns/token_authorization'
+require 'endpoint_base/concerns/sinatra_responder'
+require 'endpoint_base/concerns/rails_responder'
+require 'endpoint_base/concerns/all'

data/lib/endpoint_base/concerns/all.rb

@@ -0,0 +1,15 @@
+module EndpointBase::Concerns
+  module All
+    extend ActiveSupport::Concern
+
+    include EndpointBase::Concerns::TokenAuthorization
+    include EndpointBase::Concerns::ParamProcessor
+    include EndpointBase::Concerns::ResponseDSL
+    include EndpointBase::Concerns::ExceptionHandler
+
+    if EndpointBase.rails?
+      include EndpointBase::Concerns::RailsResponder
+    end
+  end
+end
+

data/lib/endpoint_base/concerns/exception_handler.rb

@@ -0,0 +1,26 @@
+module EndpointBase::Concerns
+  module ExceptionHandler
+    extend ActiveSupport::Concern
+
+    included do
+      if EndpointBase.rails?
+        rescue_from Exception, :with => :exception_handler
+      elsif EndpointBase.sinatra?
+        error do
+          puts env['sinatra.error'].message
+          puts env['sinatra.error'].backtrace
+        end
+      end
+    end
+
+    private
+
+    def exception_handler(exception)
+      Rails.logger.error exception.backtrace
+      render status: 500, action: '500.json.jbuilder',
+             locals: { error: exception.message }
+      return false
+    end
+
+  end
+end

data/lib/endpoint_base/concerns/param_processor.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module EndpointBase::Concerns
+  module ParamProcessor
+    extend ActiveSupport::Concern
+
+    included do
+      if EndpointBase.rails?
+        helper Helpers
+
+        before_action do
+          prepare_message params
+          prepare_config params
+        end
+
+      elsif EndpointBase.sinatra?
+        helpers Helpers
+
+        before do
+          if request.post?
+            begin
+              parsed = ::JSON.parse(request.body.read).with_indifferent_access
+            rescue Exception => e
+              halt 406
+            end
+
+            prepare_message parsed
+            prepare_config parsed
+          end
+        end
+      end
+    end
+
+    private
+
+    def prepare_message(hsh)
+      @message = hsh.slice('message_id', 'payload')
+    end
+
+    def prepare_config(hsh)
+      @config = hsh[:payload]['parameters'] || []
+      @config = @config.inject({}) do |result, param|
+        result[param[:name]] = param[:value]
+        result
+      end
+    end
+
+    module Helpers
+      def store_id
+        @config['store_id']
+      end
+    end
+  end
+end

data/lib/endpoint_base/concerns/rails_responder.rb

@@ -0,0 +1,20 @@
+module EndpointBase::Concerns
+  module RailsResponder
+    extend ActiveSupport::Concern
+
+    included do
+      if EndpointBase.rails?
+        include Helpers
+      elsif EndpointBase.sinatra?
+        raise 'This Concern is only intended to be used with Rails.'
+      end
+    end
+
+    module Helpers
+      def process_result(code)
+        render "#{EndpointBase.path_to_views}/application/response.json", status: code
+      end
+    end
+  end
+end
+

data/lib/endpoint_base/concerns/response_dsl.rb

@@ -0,0 +1,44 @@
+module EndpointBase::Concerns
+  module ResponseDSL
+    extend ActiveSupport::Concern
+
+    included do
+      if EndpointBase.rails?
+        include Helpers
+      elsif EndpointBase.sinatra?
+        helpers Helpers
+      end
+    end
+
+    private
+
+    module Helpers
+      def add_value(name, value)
+        @attrs ||= {}
+        @attrs[name] = value
+      end
+
+      def add_message(message, payload = {})
+        @messages ||= []
+
+        @messages << { message: message,
+                       payload: payload }
+      end
+
+      def add_parameter(name, value)
+        @parameters ||= []
+
+        @parameters << { name: name,
+                         value: value }
+      end
+
+      def add_notification(level, subject, description, options = {})
+        @notifications ||= []
+
+        @notifications << { level: level,
+                            subject: subject,
+                            description: description }.merge(options)
+      end
+    end
+  end
+end

data/lib/endpoint_base/concerns/sinatra_responder.rb

@@ -0,0 +1,38 @@
+module EndpointBase::Concerns
+  module SinatraResponder
+    extend ActiveSupport::Concern
+
+    included do
+      if EndpointBase.rails?
+        raise 'This Concern is only intended to be used with Sinatra.'
+      elsif EndpointBase.sinatra?
+        helpers Helpers
+
+        before do
+          if request.get? && request.path_info == '/'
+            redirect '/endpoint.json'
+          end
+        end
+
+        get '/auth' do
+          status 200
+        end
+      end
+    end
+
+    module Helpers
+      def process_result(code, response = nil)
+        status code
+        content_type 'application/json', :charset => 'utf-8'
+
+        if response
+          warn '[DEPRECATION WARNING] Passing a hash as a second argument to `process_result` is deprecated, use Response DSL instead.'
+          @attrs = response
+        end
+
+        jbuilder :'response.json', views: "#{EndpointBase.path_to_views}/application"
+      end
+    end
+  end
+end
+

data/lib/endpoint_base/concerns/token_authorization.rb

@@ -0,0 +1,28 @@
+module EndpointBase::Concerns
+  module TokenAuthorization
+    extend ActiveSupport::Concern
+
+    included do
+      if EndpointBase.rails?
+        before_action :authorize_rails
+      elsif EndpointBase.sinatra?
+        before { authorize_sinatra }
+      end
+    end
+
+    private
+
+    def authorize_rails
+      unless request.headers["HTTP_X_AUGURY_TOKEN"] == ENV['ENDPOINT_KEY']
+        render status: 401, json: {text: 'unauthorized'}
+        return false
+      end
+    end
+
+    def authorize_sinatra
+      return unless request.post?
+      halt 401 if request.env["HTTP_X_AUGURY_TOKEN"] != ENV['ENDPOINT_KEY']
+    end
+
+  end
+end

data/lib/endpoint_base/rails.rb

@@ -0,0 +1 @@
+require 'endpoint_base/rails/engine'

data/lib/endpoint_base/rails/engine.rb

@@ -0,0 +1,5 @@
+module EndpointBase::Rails
+  class Engine < ::Rails::Engine
+    include EndpointBase::Concerns::RailsResponder
+  end
+end

data/lib/endpoint_base/sinatra.rb

@@ -0,0 +1,2 @@
+require 'sinatra/jbuilder'
+require 'endpoint_base/sinatra/base'

data/lib/endpoint_base/sinatra/base.rb

@@ -0,0 +1,11 @@
+module EndpointBase
+  module Sinatra
+    class Base < ::Sinatra::Base
+      include EndpointBase::Concerns::TokenAuthorization
+      include EndpointBase::Concerns::ParamProcessor
+      include EndpointBase::Concerns::ResponseDSL
+      include EndpointBase::Concerns::SinatraResponder
+      include EndpointBase::Concerns::ExceptionHandler
+    end
+  end
+end

data/lib/endpoint_base/sinatra/integrator_utils.rb

@@ -0,0 +1,17 @@
+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