apidiesel 0.9 → 0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe3d16b8a91f4bd35deafce8149466d3815f4990
-  data.tar.gz: 20f22493471da55fb45c76931ec9a2feb24a8c46
+  metadata.gz: abd698dc7975148cd9d24f1a365abb1e21dcf873
+  data.tar.gz: 28f247075558965d6c68c59a3fa0afe9fc899ea4
 SHA512:
-  metadata.gz: 9bc4ad1cacf4576f0eaa195c7bf52553bb80cb8d5b897a2dc6c93c027dac01295f7665da3e15e2706902256708aff69935335f7f7eca76b50a218e2bbb5744ea
-  data.tar.gz: 86d14c91e1e8ff1b8db828ce61cbc7c38aa60d02672eb6e7035fc4d372b66789c5b859f278d22514e12d6f78e6e54fc3d1d7aeb05ac16866bbe73967e9ac6f7d
+  metadata.gz: 9dd5aac9aa74b83ef5a14bf1537ae97893db4f768b099464fefe0af1094da9246691e7c695543b3dfd60453f53f0e0902a23d997c9df16ffb92a2d640ca70200
+  data.tar.gz: 6f761f94ba751451f2f2fa42243bd0a54325e97f7bff55b362545f7f3f3830953df807321a0cd99dafee75b1f673c0659ea83e6d83d0b694a23f04e4275f8714

data/lib/apidiesel/action.rb

@@ -7,6 +7,8 @@ module Apidiesel
     # accessors for class instance variables
     # (class-level variables, not shared with subclasses)
     class << self
+      include Handlers
+
       attr_reader :url_args
 
       # Hash for storing validation closures. These closures are called with the request
@@ -53,7 +55,9 @@ module Apidiesel
       def url(value = nil, **args)
         return @url unless value || args.any?
 
-        if value
+        if value && value.is_a?(Proc)
+          @url = value
+        elsif value
           @url = URI.parse(value)
         else
           @url_args = args
@@ -124,10 +128,21 @@ module Apidiesel
       self.class.endpoint
     end
 
+    def base_url
+      if self.class.url.nil? || self.class.url.is_a?(Proc)
+        @api.class.url.dup
+      else
+        self.class.url.dup
+      end
+    end
+
     def url
-      url = self.class.url || @api.class.url
+      if self.class.url.is_a?(Proc)
+        url = self.class.url
+
+      elsif self.class.url_args
+        url = base_url
 
-      if self.class.url_args
         self.class.url_args.each do |key, value|
           url.send("#{key}=", value)
         end

data/lib/apidiesel/api.rb

@@ -26,17 +26,7 @@ module Apidiesel
   #
   class Api
     class << self
-      def request_handlers
-        @request_handlers ||= []
-      end
-
-      def response_handlers
-        @response_handlers ||= []
-      end
-
-      def exception_handlers
-        @exception_handlers ||= []
-      end
+      include Handlers
 
       def config(key = nil, value = nil)
         @config ||= {}
@@ -74,18 +64,18 @@ module Apidiesel
         end
       end
 
-      # Registers a handler for requests and/or responses
+      # Combined getter/setter for the HTTP Basic Auth
       #
-      # @param [Class] klass
-
-      def use(klass, *args, &block)
-        request_handler   = "#{klass.name}::RequestHandler".safe_constantize
-        response_handler  = "#{klass.name}::ResponseHandler".safe_constantize
-        exception_handler = "#{klass.name}::ExceptionHandler".safe_constantize
-
-        request_handlers   << request_handler.new(*args, &block) if request_handler
-        response_handlers  << response_handler.new(*args, &block) if response_handler
-        exception_handlers << exception_handler.new(*args, &block) if exception_handler
+      # Falls back to the Api setting if blank.
+      #
+      # @param [String] value
+      def http_basic_auth(username = nil, password = nil)
+        if username && password
+          config[:http_basic_username] = username
+          config[:http_basic_password] = password
+        else
+          return config[:http_basic_username], config[:http_basic_password]
+        end
       end
 
       # Registers the individual API endpoint definitions
@@ -120,7 +110,13 @@ module Apidiesel
     def execute_request(action_klass, *args)
       request = action_klass.new(self).build_request(*args)
 
-      self.class.request_handlers.each do |handler|
+      request_handlers =
+        action_klass.request_handlers.any? ? action_klass.request_handlers : self.class.request_handlers
+
+      response_handlers =
+        action_klass.response_handlers.any? ? action_klass.response_handlers : self.class.response_handlers
+
+      request_handlers.each do |handler|
         request = handler.run(request, @config)
         break if request.response_body.present?
       end
@@ -129,12 +125,12 @@ module Apidiesel
         raise "All request handlers failed to deliver a response"
       end
 
-      self.class.response_handlers.each do |handler|
+      response_handlers.each do |handler|
         request = handler.run(request, @config)
       end
 
       response_handler_klasses =
-        self.class.response_handlers.collect { |handler| handler.class.name.to_s.demodulize }
+        response_handlers.collect { |handler| handler.class.name.split('::')[-2] }
 
       # Execute the actions' `responds_with` block automatically, unless
       # the handler has been included manually in order to control the
@@ -145,7 +141,10 @@ module Apidiesel
 
       request
     rescue => e
-      self.class.exception_handlers.each do |handler|
+      exception_handlers =
+        action_klass.exception_handlers.any? ? action_klass.exception_handlers : self.class.exception_handlers
+
+      exception_handlers.each do |handler|
         request = handler.run(e, request, @config)
       end
 

data/lib/apidiesel/dsl.rb

@@ -369,7 +369,7 @@ module Apidiesel
       #     integer :order_id
       #     datetime :ordered_at
       #
-      #     an_array_of :products do
+      #     array :products do
       #       string :name
       #       integer :product_id
       #     end
@@ -390,7 +390,7 @@ module Apidiesel
       #
       # @example
       #   expects do
-      #     an_array_of do
+      #     array do
       #       string :name
       #       integer :order_id
       #     end
@@ -410,7 +410,7 @@ module Apidiesel
         args = normalize_arguments(args, kargs)
 
         response_formatters << lambda do |data, processed_data|
-          data = get_value(data, args[:at])
+          data = get_value(data, args[:at]) if args[:at]
 
           return processed_data unless data.present?
 
@@ -438,9 +438,12 @@ module Apidiesel
             result
           end
 
-          processed_data[ args[:as] ] = array_of_hashes.compact
-
-          processed_data
+          if args[:as]
+            processed_data[ args[:as] ] = array_of_hashes.compact
+            processed_data
+          else
+            array_of_hashes.compact
+          end
         end
       end
 

data/lib/apidiesel/handlers/http_request_helper.rb

@@ -11,9 +11,13 @@ module Apidiesel
       #               instance, as given to the handlers #run method
       #
       def execute_request(request:, payload:, api_config:)
-        http_request      = HTTPI::Request.new(request.action.url.try(:to_s))
+        http_request      = HTTPI::Request.new(request.url.try(:to_s))
         http_request.body = payload
 
+        if api_config[:http_basic_username] && api_config[:http_basic_password]
+          http_request.auth.basic(api_config[:http_basic_username], api_config[:http_basic_password])
+        end
+
         http_request.auth.ssl.verify_mode = api_config[:ssl_verify_mode] || :peer
         http_request.open_timeout         = api_config[:timeout] || 30
         http_request.read_timeout         = api_config[:timeout] || 30
@@ -28,7 +32,7 @@ module Apidiesel
         end
 
         if response.error?
-          raise RequestError.new("#{request.action.http_method} #{request.action.url} returned #{response.code}", request)
+          raise RequestError.new("#{request.action.http_method} #{request.url} returned #{response.code}", request)
         end
 
         request

data/lib/apidiesel/handlers/json.rb

@@ -0,0 +1,27 @@
+module Apidiesel
+  module Handlers
+    module JSON
+      class RequestHandler
+        include HttpRequestHelper
+
+        def run(request, api_config)
+          action = request.action
+
+          payload = ::JSON.dump(request.parameters)
+
+          request.metadata[:started_at] = DateTime.now
+
+          execute_request(request: request,
+                          payload: payload,
+                          api_config: api_config)
+
+          request.metadata[:finished_at] = DateTime.now
+
+          request.response_body = ::JSON.parse(request.http_response.body)
+
+          request
+        end
+      end
+    end
+  end
+end

data/lib/apidiesel/handlers.rb

@@ -0,0 +1,28 @@
+module Apidiesel
+  module Handlers
+    def request_handlers
+      @request_handlers ||= []
+    end
+
+    def response_handlers
+      @response_handlers ||= []
+    end
+
+    def exception_handlers
+      @exception_handlers ||= []
+    end
+
+    # Registers a handler for requests, responses and/or exceptions
+    #
+    # @param [Class] klass
+    def use(klass, *args, &block)
+      request_handler   = "#{klass.name}::RequestHandler".safe_constantize
+      response_handler  = "#{klass.name}::ResponseHandler".safe_constantize
+      exception_handler = "#{klass.name}::ExceptionHandler".safe_constantize
+
+      request_handlers   << request_handler.new(*args, &block) if request_handler
+      response_handlers  << response_handler.new(*args, &block) if response_handler
+      exception_handlers << exception_handler.new(*args, &block) if exception_handler
+    end
+  end
+end

data/lib/apidiesel/request.rb

@@ -13,6 +13,16 @@ module Apidiesel
       @metadata   = metadata
     end
 
+    def url
+      @url ||=
+        case action.url
+        when Proc
+          action.url.call(action.base_url, self)
+        when URI
+          action.url
+        end
+    end
+
     def response_body
       @response_body || http_response.try(:body)
     end
@@ -31,7 +41,7 @@ module Apidiesel
       [
         "Apidiesel::Request",
         action.http_method.to_s.upcase,
-        action.url.try(:to_s),
+        url.try(:to_s),
         action.endpoint,
         parameters.collect { |key, value| "#{key}: #{value}"}.join(',')
       ].join(' ')

data/lib/apidiesel/version.rb

@@ -1,3 +1,3 @@
 module Apidiesel
-  VERSION = "0.9"
+  VERSION = "0.10"
 end

data/lib/apidiesel.rb

@@ -6,10 +6,12 @@ HTTPI.log = false
 require 'apidiesel/version'
 
 require 'apidiesel/errors'
+require 'apidiesel/handlers'
 require 'apidiesel/api'
 require 'apidiesel/dsl'
 require 'apidiesel/request'
 require 'apidiesel/action'
 require 'apidiesel/handlers/action_response_processor'
 require 'apidiesel/handlers/http_request_helper'
+require 'apidiesel/handlers/json'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apidiesel
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Jan-Christian Foeh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -88,8 +88,10 @@ files:
 - lib/apidiesel/api.rb
 - lib/apidiesel/dsl.rb
 - lib/apidiesel/errors.rb
+- lib/apidiesel/handlers.rb
 - lib/apidiesel/handlers/action_response_processor.rb
 - lib/apidiesel/handlers/http_request_helper.rb
+- lib/apidiesel/handlers/json.rb
 - lib/apidiesel/handlers/mock_response.rb
 - lib/apidiesel/request.rb
 - lib/apidiesel/version.rb