apidiesel 0.1.3 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 798839eabb874dd1436557c30354b5db5c34cbeb
-  data.tar.gz: a32a71d7c332df16d34adefdbcf210de2ae7797f
+  metadata.gz: d15d627f5ccaedcfd3a26398782dee3ddd2a1884
+  data.tar.gz: bccf9fdf4ec8300f6f115d71da7deb77790e62e0
 SHA512:
-  metadata.gz: 8a49d3ba3ca856b677049a6f7f42901a04962624ab7fd04a8d2054283c6db0d571076546120a549976b4a1ab702c036423877842ed7668fc9c7014a188724ace
-  data.tar.gz: 327efab8c20eb431b8f410d85613a64ceeb8e2493312b36882f0d5c9ef992efb57c6d05dcc1865d1e35b396b3881226631d0c7a6cad44fb69486cc722369859f
+  metadata.gz: 31aacd8dd6e107102d96a6523acea5e24d463f1b54c1578155046afce20d1f61f646513299ef1b63cdef0a6407ad1062cc4cf55c4e62fac933a85b78d8822227
+  data.tar.gz: ecc0307c212442ea40418f251df6471483c06520777f50ef063107941e1918a4ae5cfbaf435bb67e9707bf93e846997b75f184e53694875043e187f0ad76b7a0

data/README.md

@@ -1,8 +1,7 @@
 # Apidiesel
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apidiesel`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Apidiesel is a DSL for building API clients. It is made to be highly readable,
+easily extensible and to assume as little as possible about your API.
 
 ## Installation
 
@@ -22,7 +21,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Apidiesel consists of three main parts: the base `Api`, one `Action` for each API
+endpoint and `Handler` plugins for processing incoming and outgoing data.
+
+    module Actions
+      class GetUsers < Apidiesel::Action
+        url path: '/users'
+
+        expects do
+          string :firstname, optional: true
+          string :lastname, optional: true
+          boolean :active, default: true
+        end
+
+        responds_with do
+          objects :users, wrapped_in: MyUserModel
+        end
+      end
+    end
+
+    class Api < Apidiesel::Api
+      url 'https://foo.example'
+      http_method :post
+
+      register_actions
+    end
+
+    api = Api.new
+    api.get_users(firstname: 'Jane', lastname: 'Doe')
 
 ## Development
 

data/lib/apidiesel/dsl.rb

@@ -210,6 +210,95 @@ module Apidiesel
         copy_value_directly(key, *args)
       end
 
+      # Returns an array of subhashes
+      #
+      # @example
+      #
+      #   # Given an API response:
+      #   #
+      #   # {
+      #   #   order_id: 5,
+      #   #   ordered_at :"2020-01-01",
+      #   #   products: [{
+      #   #     name: 'Catnip 2lbs',
+      #   #     product_id: 2004921
+      #   #   }]
+      #   # }
+      #
+      #   expects do
+      #     integer :order_id
+      #     datetime :ordered_at
+      #
+      #     an_array_of :products do
+      #       string :name
+      #       integer :product_id
+      #     end
+      #   end
+      #
+      #   # Given an API response:
+      #   #
+      #   # [
+      #   #   {
+      #   #     name: 'Catnip 2lbs',
+      #   #     order_id: 2004921
+      #   #   },
+      #   #   {
+      #   #     name: 'Catnip 5lbs',
+      #   #     order_id: 2004922
+      #   #   },
+      #   # ]
+      #
+      # @example
+      #   expects do
+      #     an_array_of 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 an_array_of(*args, **kargs, &block)
+        if args.length == 1
+          kargs[:as] ||= args.first
+          kargs[:at] ||= args.first
+        end
+
+        response_formatters << lambda do |data, processed_data|
+          if kargs[:at]
+            data = data[ kargs[:at] ]
+          end
+
+          return processed_data unless data.present?
+
+          data = [data] if data.is_a?(Hash)
+
+          array_of_hashes = data.map do |hash|
+            builder = FilterBuilder.new
+            builder.instance_eval(&block)
+
+            result = {}
+
+            builder.response_formatters.each do |filter|
+              result = filter.call(hash, result)
+            end
+
+            result
+          end
+
+          if kargs[:as]
+            processed_data[ kargs[:as] ] = array_of_hashes
+          else
+            processed_data = array_of_hashes
+          end
+
+          processed_data
+        end
+      end
+
       # Returns the API response processed or wrapped in wrapper objects.
       #
       # @example

data/lib/apidiesel/version.rb

@@ -1,3 +1,3 @@
 module Apidiesel
-  VERSION = "0.1.3"
+  VERSION = "0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apidiesel
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: '0.2'
 platform: ruby
 authors:
 - Jan-Christian Foeh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport