apidiesel 0.12 → 0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08fe77f23044c1ce2a36e5bd94e2c017a0683c9c
-  data.tar.gz: fb4e57bad12bd7f33791bd7ec5271210543cd047
+  metadata.gz: 9da8479808b1cfc506569b246e5dc7901d51d8be
+  data.tar.gz: 853d657cf6fbb75d6b0518900aa1375813b5e035
 SHA512:
-  metadata.gz: bbff420944f968b9f9a9de1be0db1af02856da7b407e8fbf3a3580f4d914cf9754d621413c05d50eccbbace72e2ed2947eb4e8235bb3a29549eb4fd48db92212
-  data.tar.gz: 84c5a28bde9e6043a9ad0583e63735bcd7be360e7db8fc315d07ba2bbbf6701e4b2611dc12351ec11fcceb9898f8505769dba7cc9113e765b6a8d57a5400618d
+  metadata.gz: bb0cbe4ab97aa00a61c4dba87f93a9238060bc3847a82226cf16ab3aeb5e3cd2dc8b1bdfab89b094e79fe0077553955b5a4e85b6e17d8274adedaca4740bf785
+  data.tar.gz: af20d68bf9143dee06a5686f4c7092310e4f09b5a76ce2b10321310a6a97ae1cb79cd97034cf72b6466d795de0ddf1461d263a14bc0c42e0dc2e50bb5961034d

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown

data/apidiesel.gemspec

@@ -25,4 +25,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "redcarpet", "~> 3.3"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency 'pry-byebug', '~> 3.2.0'
+  spec.add_development_dependency 'pry-rescue', '~> 1.4'
+  spec.add_development_dependency 'pry-stack_explorer', '~> 0.4.9'
 end

data/bin/console

@@ -10,5 +10,5 @@ require "apidiesel"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/examples/github/actions/get_user_repos.rb

@@ -0,0 +1,102 @@
+module Github
+  module Actions
+    class GetUserRepos < Apidiesel::Action
+      url path: '/users/%{username}/repos'
+
+      expects do
+        string :username, submit: false
+      end
+
+      responds_with do
+        array do
+          integer :id
+          string :name
+          string :full_name
+          hash :owner do
+            string :login
+            integer :id
+            string :avatar_url
+            string :gravatar_id
+            string :url
+            string :html_url
+            string :followers_url
+            string :following_url
+            string :gists_url
+            string :starred_url
+            string :subscriptions_url
+            string :organizations_url
+            string :repos_url
+            string :events_url
+            string :received_events_url
+            string :type
+            string :site_admin
+          end
+          boolean :private
+          string :html_url
+          string :description
+          string :fork
+          string :url
+          string :forks_url
+          string :keys_url
+          string :collaborators_url
+          string :teams_url
+          string :hooks_url
+          string :issue_events_url
+          string :events_url
+          string :assignees_url
+          string :branches_url
+          string :tags_url
+          string :blobs_url
+          string :git_tags_url
+          string :git_refs_url
+          string :trees_url
+          string :statuses_url
+          string :languages_url
+          string :stargazers_url
+          string :contributors_url
+          string :subscribers_url
+          string :subscription_url
+          string :commits_url
+          string :git_commits_url
+          string :comments_url
+          string :issue_comment_url
+          string :contents_url
+          string :compare_url
+          string :merges_url
+          string :archive_url
+          string :downloads_url
+          string :issues_url
+          string :pulls_url
+          string :milestones_url
+          string :notifications_url
+          string :labels_url
+          string :releases_url
+          string :deployments_url
+          datetime :created_at
+          datetime :updated_at
+          datetime :pushed_at
+          string :git_url
+          string :ssh_url
+          string :clone_url
+          string :svn_url
+          string :homepage
+          integer :size
+          integer :stargazers_count
+          integer :watchers_count
+          string :language
+          boolean :has_issues
+          boolean :has_downloads
+          boolean :has_wiki
+          boolean :has_pages
+          integer :forks_count
+          string :mirror_url
+          integer :open_issues_count
+          integer :forks
+          integer :open_issues
+          integer :watchers
+          string :default_branch
+        end
+      end
+    end
+  end
+end

data/examples/github/api.rb

@@ -0,0 +1,15 @@
+require "apidiesel"
+
+Dir[ File.join(__dir__, 'actions', '*.rb') ].each do |file|
+  require file
+end
+
+module Github
+  class Api < Apidiesel::Api
+    use Apidiesel::Handlers::JSON
+
+    url 'https://api.github.com'
+
+    register_actions
+  end
+end

data/lib/apidiesel.rb

@@ -1,5 +1,6 @@
 require 'uri'
 require 'httpi'
+require 'active_support/all'
 
 HTTPI.log = false
 
@@ -13,5 +14,4 @@ require 'apidiesel/request'
 require 'apidiesel/action'
 require 'apidiesel/handlers/action_response_processor'
 require 'apidiesel/handlers/http_request_helper'
-require 'apidiesel/handlers/json'
-
+require 'apidiesel/handlers/json'

data/lib/apidiesel/action.rb

@@ -9,15 +9,20 @@ module Apidiesel
     class << self
       include Handlers
 
-      attr_reader :url_args
+      attr_reader :url_value, :url_args
 
-      # Hash for storing validation closures. These closures are called with the request
+      # Array for storing parameter validation closures. These closures are called with the request
       # parameters before the request is made and have the opportunity to check and modify them.
       def parameter_validations
         @parameter_validations ||= []
       end
 
-      # Hash for storing filter closures. These closures are called with the received data
+      # Array for storing action argument names which are not to be submitted as parameters
+      def parameters_to_filter
+        @parameters_to_filter ||= []
+      end
+
+      # Array for storing filter closures. These closures are called with the received data
       # after a request is made and have the opportunity to modify or check it before the
       # data is returned
       def response_filters
@@ -47,21 +52,78 @@ module Apidiesel
         end
       end
 
-      # Combined getter/setter for this actions URL
+      # Defines this Actions URL, or modifies the base URL set on `Api`
       #
-      # Falls back to the Api setting if blank.
+      # Given keyword arguments such as `path:` will be applied to
+      # the `URI` object supplied to `Api.url`.
       #
-      # @param [String] value
-      def url(value = nil, **args)
-        return @url unless value || args.any?
-
-        if value && value.is_a?(Proc)
-          @url = value
-        elsif value
-          @url = URI.parse(value)
-        else
-          @url_args = args
+      # Accepts a `Proc`, which will be called at request time with
+      # the URL constructed so far and the current `Request` object.
+      #
+      # A string value and all keyword arguments can contain
+      # placeholders for all arguments supplied to the action in
+      # Rubys standard `String.%` syntax.
+      #
+      # @example
+      #   class Api < Apidiesel::Api
+      #     url 'https://foo.example'
+      #
+      #     register_actions
+      #   end
+      #
+      #   module Actions
+      #     # modify the base URL set on `Api`
+      #     class ActionA < Apidiesel::Action
+      #       url path: '/action_a'
+      #     end
+      #
+      #     # replace the base URL set on `Api`
+      #     class ActionB < Apidiesel::Action
+      #       url 'https://subdomain.foo.example'
+      #     end
+      #
+      #     # modify the base URL set on `Api` with a
+      #     # 'username' argument placeholder
+      #     class ActionC < Apidiesel::Action
+      #       url path: '/action_c/%{username}'
+      #
+      #       expects do
+      #         string :username, submit: false
+      #       end
+      #     end
+      #
+      #     # dynamically determine the URL with a
+      #     # `Proc` object
+      #     class ActionD < Apidiesel::Action
+      #       url ->(url, request) {
+      #         url.path = '/' + request.action_arguments[:username]
+      #                                 .downcase
+      #         url
+      #       }
+      #
+      #       expects do
+      #         string :username, submit: false
+      #       end
+      #     end
+      #   end
+      #
+      # @overload url(value)
+      #   @param [String, URI] value a complete URL string or `URI`
+      #
+      # @overload url(**kargs)
+      #   @option **kargs [String] any method name valid on Rubys `URI::Generic`
+      #
+      # @overload url(value)
+      #   @param [Proc] value a callback that returns a URL string at request time.
+      #                       Receives the URL contructed so far and the current
+      #                       `Request` instance.
+      def url(value = nil, **kargs)
+        if value && kargs.any?
+          raise ArgumentError, "you cannot supply both argument and keyword args"
         end
+
+        @url_value  = value
+        @url_args   = kargs
       end
 
       # Combined getter/setter for the HTTP method used
@@ -128,42 +190,17 @@ 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
-      if self.class.url.is_a?(Proc)
-        url = self.class.url
-
-      elsif self.class.url_args
-        url = base_url
-
-        self.class.url_args.each do |key, value|
-          url.send("#{key}=", value)
-        end
-      end
-
-      url
-    end
-
     def http_method
-      self.class.http_method || @api.class.http_method
+      self.class.http_method || @api.class.http_method || :get
     end
 
     # Performs the action-specific input validations on `*args` according to the actions
     # `expects` block, executes the API request and prepares the data according to the
     # actions `responds_with` block.
     #
-    # @param [Hash] *args see specific, non-abstract `Apidiesel::Action`
+    # @option **args see specific, non-abstract `Apidiesel::Action`
     # @return [Apidiesel::Request]
-    def build_request(*args)
-      args = args && args.first.is_a?(Hash) ? args.first : {}
-
+    def build_request(**args)
       params = {}
 
       self.class.parameter_validations.each do |validation|
@@ -172,9 +209,14 @@ module Apidiesel
 
       if self.class.parameter_formatter
         params = self.class.parameter_formatter.call(params)
+      else
+        params.except!(*self.class.parameters_to_filter)
       end
 
-      Apidiesel::Request.new action: self, parameters: params
+      request = Apidiesel::Request.new(action: self, action_arguments: args, parameters: params)
+      request.url = build_url(args, request)
+
+      request
     end
 
     def process_response(response_data)
@@ -208,6 +250,34 @@ module Apidiesel
 
       protected
 
+    # @return [URI]
+    def build_url(action_arguments, request)
+      url = case self.class.url_value
+      when String
+        URI( self.class.url_value % action_arguments )
+      when URI
+        self.class.url_value
+      when Proc
+        self.class.url_value.call(base_url, request)
+      when nil
+        base_url
+      end
+
+      url_args = self.class.url_args.transform_values do |value|
+        value % action_arguments
+      end
+
+      url_args.each do |name, value|
+        url.send("#{name}=", value)
+      end
+
+      url
+    end
+
+    def base_url
+      @api.class.url.nil? ? URI('http://') : @api.class.url.dup
+    end
+
     # @return [Hash] Apidiesel configuration options
     def config
       Apidiesel::CONFIG[environment]

data/lib/apidiesel/api.rb

@@ -42,7 +42,7 @@ module Apidiesel
       #
       # Falls back to the Api setting if blank.
       #
-      # @param [String] value
+      # @param [String] base_url
       def url(base_url = nil)
         if base_url
           config[:url] = URI.parse(base_url)
@@ -68,7 +68,8 @@ module Apidiesel
       #
       # Falls back to the Api setting if blank.
       #
-      # @param [String] value
+      # @param [String] username
+      # @param [String] password
       def http_basic_auth(username = nil, password = nil)
         if username && password
           config[:http_basic_username] = username

data/lib/apidiesel/dsl.rb

@@ -17,6 +17,7 @@ module Apidiesel
       builder = ExpectationBuilder.new
       builder.instance_eval(&block)
       parameter_validations.concat builder.parameter_validations
+      parameters_to_filter.concat builder.parameters_to_filter
     end
 
     # Defines the expected content and format of the response for this API action.
@@ -53,10 +54,13 @@ module Apidiesel
     # ExpectationBuilder defines the methods available within an `expects` block
     # when defining an API action.
     class ExpectationBuilder
-      attr_accessor :parameter_validations
+      # @!visibility private
+      attr_accessor :parameter_validations, :parameters_to_filter
 
+      # @!visibility private
       def initialize
         @parameter_validations  = []
+        @parameters_to_filter   = []
       end
 
       # Defines a string parameter.
@@ -71,19 +75,23 @@ module Apidiesel
       #   # This action expects to be given an 'email', which is sent to the API as 'username',
       #   # and requires either a 'value1', a 'value2' or both to be present.
       #
-      # @param [Symbol] param_name name of the parameter
-      # @param [Hash] *args
-      # @option *args [Boolean] :optional (false) defines whether this parameter may be omitted
-      # @option *args [Symbol] :optional_if_present param_name is optional, if the parameter given here is present instead
-      # @option *args [Symbol] :required_if_present param_name is required if param_name is also present
-      # @option *args [Symbol] :submitted_as submit param_name to the API under the name given here
-      # @option *args [Object] :default a default parameter to be set when no value is specified
-      # @option *args [Enumerable] :allowed_values only accept the values in this Enumerable.
-      #                             If Enumerable is a Hash, use the hash values to define what is actually
-      #                             sent to the server. Example: `:allowed_values => {:foo => "f"}` allows
-      #                             the value ':foo', but sends it as 'f'
-      def string(param_name, *args)
-        validation_builder(:to_s, param_name, *args)
+      # @!macro [new] expectation_types
+      #   @param param_name [Symbol] name of the parameter
+      #   @option args [Boolean] :optional (false) defines whether this parameter may be omitted
+      #   @option args [Symbol] :optional_if_present param_name is optional, if the parameter given here is present instead
+      #   @option args [Symbol] :required_if_present param_name is required if param_name is also present
+      #   @option args [Symbol] :submitted_as submit param_name to the API under the name given here
+      #   @option args [Object] :default a default parameter to be set when no value is specified
+      #   @option args [true, false] :submit (true) set to `false` for arguments that should not be submitted
+      #                                               as API parameters
+      #   @option args [Enumerable] :allowed_values only accept the values in this Enumerable.
+      #                               If Enumerable is a Hash, use the hash values to define what is actually
+      #                               sent to the server. Example: `:allowed_values => {:foo => "f"}` allows
+      #                               the value ':foo', but sends it as 'f'
+      #   @return [nil]
+      def string(param_name, **args)
+        validation_builder(:to_s, param_name, **args)
+        parameters_to_filter << param_name if args[:submit] == false
       end
 
       # Defines an integer parameter.
@@ -93,10 +101,10 @@ module Apidiesel
       #     integer :per_page, :optional => true
       #   end
       #
-      # @param (see #string)
-      # @option (see #string)
-      def integer(param_name, *args)
-        validation_builder(:to_i, param_name, *args)
+      # @!macro expectation_types
+      def integer(param_name, **args)
+        validation_builder(:to_i, param_name, **args)
+        parameters_to_filter << param_name if args[:submit] == false
       end
 
       # Defines a boolean parameter.
@@ -108,10 +116,10 @@ module Apidiesel
       #     boolean :per_page, :optional => true
       #   end
       #
-      # @param (see #string)
-      # @option (see #string)
-      def boolean(param_name, *args)
-        validation_builder(:to_s, param_name, *args)
+      # @!macro expectation_types
+      def boolean(param_name, **args)
+        validation_builder(:to_s, param_name, **args)
+        parameters_to_filter << param_name if args[:submit] == false
       end
 
       # Defines a date, time or datetime parameter.
@@ -122,15 +130,15 @@ module Apidiesel
       #     datetime :starts_at, format: '%d-%m-%Y'
       #   end
       #
-      # @param (see #string)
-      # @option *args [String] :format strftime format string
-      # @option (see #string)
+      # @!macro expectation_types
+      # @option args [String] :format a format string as supported by Rubys `#strftime`
       def datetime(param_name, **args)
         if args[:format]
           args[:processor] = ->(value) { value.try(:strftime, args[:format]) }
         end
 
         validation_builder(:strftime, param_name, **args)
+        parameters_to_filter << param_name if args[:submit] == false
       end
 
       alias_method :time, :datetime
@@ -144,9 +152,8 @@ module Apidiesel
       #     object :contract, klass: Contract
       #   end
       #
-      # @param (see #string)
-      # @option *args [Class] :klass
-      # @option (see #string)
+      # @!macro expectation_types
+      # @option args [Class] :klass the expected class of the value
       def object(param_name, **args)
         type_check = ->(value, param_name) {
           unless value.is_a?(args[:klass])
@@ -155,12 +162,13 @@ module Apidiesel
         }
 
         validation_builder(type_check, param_name, **args)
+        parameters_to_filter << param_name if args[:submit] == false
       end
 
         protected
 
-      def validation_builder(duck_typing_check, param_name, *args)
-        options = args.extract_options!
+      def validation_builder(duck_typing_check, param_name, **args)
+        options = args
 
         parameter_validations << lambda do |given_params, processed_params|
           if options[:default]
@@ -211,13 +219,38 @@ module Apidiesel
     # FilterBuilder defines the methods available within an `responds_with` block
     # when defining an API action.
     class FilterBuilder
+      # @!visibility private
       attr_accessor :response_filters, :response_formatters
 
+      # @!visibility private
       def initialize
         @response_filters    = []
         @response_formatters = []
       end
 
+      # @!macro [new] filter_types
+      #   Returns a $0 from the API response hash
+      #
+      #   @overload $0(key, **kargs)
+      #     Get the $0 named `key` from the response hash and name it `key` in the result hash
+      #
+      #     @param key [String, Symbol]
+      #     @option kargs [Proc] :prefilter callback for modifying the value before typecasting
+      #     @option kargs [Proc] :postfilter callback for modifying the value after typecasting
+      #     @option kargs [Proc] :filter alias for :postfilter
+      #     @option kargs [Hash] :map a hash map for replacing the value
+      #
+      #   @overload $0(at:, as:, **kargs)
+      #     Get the $0 named `at:` from the response hash and name it `as:` in the result hash
+      #
+      #     @param at [String, Symbol, Array<Symbol>] response hash key name or key path to lookup
+      #     @param as [String, Symbol] result hash key name to return the value as
+      #     @option kargs [Proc] :prefilter callback for modifying the value before typecasting
+      #     @option kargs [Proc] :postfilter callback for modifying the value after typecasting
+      #     @option kargs [Proc] :filter alias for :postfilter
+      #     @option kargs [Hash] :map a hash map for replacing the value
+      #
+      #   @return [nil]
       def value(*args, **kargs)
         args = normalize_arguments(args, kargs)
 
@@ -236,43 +269,65 @@ module Apidiesel
         end
       end
 
-      # Returns `key` from the API response as a string.
+      # @!macro filter_types
       #
-      # @param [Symbol] key the key name to be returned as a string
-      # @param [Hash] *args
-      # @option *args [Symbol] :within look up the key in a namespace (nested hash)
+      # Please note that response value is typecasted to `String` for comparison, so that
+      # for absent values to be considered false, you have to include an empty string.
+      #
+      # @option kargs [Array<#to_s>, #to_s] :truthy ('true') values to be considered true
+      # @option kargs [Array<#to_s>, #to_s] :falsy ('false') values to be considered false
+      def boolean(*args, **kargs)
+        args = normalize_arguments(args, kargs)
+
+        args.reverse_merge!(truthy: 'true', falsy: 'false')
+
+        args[:truthy] = Array(args[:truthy]).map(&:to_s)
+        args[:falsy]  = Array(args[:falsy]).map(&:to_s)
+
+        response_formatters << lambda do |data, processed_data|
+          value = get_value(data, args[:at])
+
+          value = apply_filter(args[:prefilter], value)
+
+          value = if args[:truthy].include?(value.to_s)
+            true
+          elsif args[:falsy].include?(value.to_s)
+            false
+          else
+            nil
+          end
+
+          value = apply_filter(args[:postfilter] || args[:filter], value)
+
+          value = args[:map][value] if args[:map]
+
+          processed_data[ args[:as] ] = value
+
+          processed_data
+        end
+      end
+
+      # @!macro filter_types
       def string(*args, **kargs)
         create_primitive_formatter(:to_s, *args, **kargs)
       end
 
-      # Returns `key` from the API response as an integer.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def integer(*args, **kargs)
         create_primitive_formatter(:to_i, *args, **kargs)
       end
 
-      # Returns `key` from the API response as a float.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def float(*args, **kargs)
         create_primitive_formatter(:to_f, *args, **kargs)
       end
 
-      # Returns `key` from the API response as a symbol.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def symbol(*args, **kargs)
         create_primitive_formatter(:to_sym, *args, **kargs)
       end
 
-      # Returns `key` from the API response as DateTime.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def datetime(*args, **kargs)
         args = normalize_arguments(args, kargs)
         args.reverse_merge!(format: '%Y-%m-%d')
@@ -296,10 +351,7 @@ module Apidiesel
         end
       end
 
-      # Returns `key` from the API response as Date.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def date(*args, **kargs)
         args = normalize_arguments(args, kargs)
         args.reverse_merge!(format: '%Y-%m-%d')
@@ -323,10 +375,7 @@ module Apidiesel
         end
       end
 
-      # Returns `key` from the API response as Time.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def time(*args, **kargs)
         args = normalize_arguments(args, kargs)
         args.reverse_merge!(format: '%Y-%m-%d')
@@ -350,8 +399,7 @@ module Apidiesel
         end
       end
 
-      # Returns an array of subhashes
-      #
+      # @!macro filter_types
       # @example
       #
       #   # Given an API response:
@@ -375,6 +423,7 @@ module Apidiesel
       #     end
       #   end
       #
+      # @example
       #   # Given an API response:
       #   #
       #   # [
@@ -388,19 +437,12 @@ module Apidiesel
       #   #   },
       #   # ]
       #
-      # @example
       #   expects do
       #     array do
       #       string :name
       #       integer :order_id
       #     end
       #   end
-      #
-      # @option *args [Symbol] the key for finding and returning the array
-      #                        (sets both :as and :at)
-      # @option **kargs [Symbol] :at which key to find the hash at in the
-      #                              response
-      # @option **kargs [Symbol] :as which key to return the result under
       def array(*args, **kargs, &block)
         unless block.present?
           create_primitive_formatter(:to_a, *args, **kargs)
@@ -447,10 +489,7 @@ module Apidiesel
         end
       end
 
-      # Returns `key` from the API response as a hash.
-      #
-      # @param (see #string)
-      # @option (see #string)
+      # @!macro filter_types
       def hash(*args, **kargs, &block)
         unless block.present?
           create_primitive_formatter(:to_hash, *args, **kargs)
@@ -483,24 +522,24 @@ module Apidiesel
         end
       end
 
-      # Returns the API response processed or wrapped in wrapper objects.
-      #
       # @example
       #   responds_with do
-      #     object :issues, :processed_with => lambda { |data| data.delete_if { |k,v| k == 'www_id' } }
+      #     object :issues,
+      #             processed_with: ->(data) {
+      #               data.delete_if { |k,v| k == 'www_id' }
+      #             }
       #   end
       #
       # @example
       #
       #   responds_with do
-      #     object :issues, :wrapped_in => Apidiesel::ResponseObjects::Topic
+      #     object :issues,
+      #             wrapped_in: Apidiesel::ResponseObjects::Topic
       #   end
       #
-      # @param [Symbol] key the key name to be wrapped or processed
-      # @option *args [Symbol] :within look up the key in a namespace (nested hash)
-      # @option *args [Proc] :processed_with yield the data to this Proc for processing
-      # @option *args [Class] :wrapped_in wrapper object, will be called as `Object.create(data)`
-      # @option *args [Symbol] :as key name to save the result as
+      # @!macro filter_types
+      # @option kargs [Proc] :processed_with yield the data to this Proc for processing
+      # @option kargs [Class] :wrapped_in wrapper object, will be called as `Object.create(data)`
       def objects(*args, **kargs)
         args = normalize_arguments(args, kargs)
 
@@ -530,7 +569,7 @@ module Apidiesel
       # @param [Symbol, Array] key
       def set_scope(key)
         response_filters << lambda do |data|
-          begin; fetch_path(data, *key); rescue => e; binding.pry; end
+          fetch_path(data, *key)
         end
       end
 
@@ -543,7 +582,7 @@ module Apidiesel
       #
       # @param [Lambda, Proc] callable
       # @param [String, Lambda, Proc] message
-      # @raises [Apidiesel::ResponseError]
+      # @raise [Apidiesel::ResponseError]
       def response_error_if(callable, message:)
         response_formatters << lambda do |data, processed_data|
           return processed_data unless callable.call(data)

data/lib/apidiesel/request.rb

@@ -2,25 +2,17 @@ module Apidiesel
 
   # Wrapper for API requests
   class Request
-    attr_accessor :action, :parameters, :response_body, :http_request, :http_response, :metadata, :result
+    attr_accessor :action, :action_arguments, :parameters, :url, :response_body, :http_request, :http_response, :metadata, :result
 
     # @param [Apidiesel::Action] action
+    # @param [Hash] action_arguments
     # @param [Hash] parameters
     # @param [Hash] metadata
-    def initialize(action:, parameters:, metadata: {})
-      @action     = action
-      @parameters = parameters
-      @metadata   = metadata
-    end
-
-    def url
-      @url ||=
-        case action.url
-        when Proc
-          action.url.call(action.base_url, self)
-        when URI
-          action.url
-        end
+    def initialize(action:, action_arguments:, parameters:, metadata: {})
+      @action           = action
+      @action_arguments = action_arguments
+      @parameters       = parameters
+      @metadata         = metadata
     end
 
     def response_body

data/lib/apidiesel/version.rb

@@ -1,3 +1,3 @@
 module Apidiesel
-  VERSION = "0.12"
+  VERSION = "0.13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apidiesel
 version: !ruby/object:Gem::Version
-  version: '0.12'
+  version: '0.13'
 platform: ruby
 authors:
 - Jan-Christian Foeh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-29 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.9
 description: 
 email:
 - jan@programmanstalt.de
@@ -76,6 +160,7 @@ files:
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -83,6 +168,8 @@ files:
 - apidiesel.gemspec
 - bin/console
 - bin/setup
+- examples/github/actions/get_user_repos.rb
+- examples/github/api.rb
 - lib/apidiesel.rb
 - lib/apidiesel/action.rb
 - lib/apidiesel/api.rb
@@ -120,3 +207,4 @@ signing_key:
 specification_version: 4
 summary: Build API clients through an expressive DSL
 test_files: []
+has_rdoc: