dwolla_v2 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 811f43c8507739f9ba53fbd843f3d38c7d9554e7
-  data.tar.gz: 6f90eb874890c98cb2045de7ec2f107ca329ac07
+  metadata.gz: 347bf32bfbb4db49d6341c3db975cf696a97f492
+  data.tar.gz: 38d265059cb4ddac927d141096bd145a76cf2c60
 SHA512:
-  metadata.gz: b3d569ab13c930ca10eb2ce1d1ed077d08416cdaa020049929e1739d1ebb21a48f0950fad72091158656e05bb2b92ab55411b979d4a389f84d39aa15bdb7db03
-  data.tar.gz: 0f1af22dfb1dca2db0855c16b50907f8ae0839431d5cfdaa8b03e0e851d5fb26a18e6aed6be4856cfdf84a71b95da088be7d5c8811e38775f039f114eb9ee832
+  metadata.gz: 053be0c20b5da0da5c421dcb8979ca1aefcc4a6620c8383e2251b0e458042b222c5c76682051d08706fe2a9f9d8e043d8702bcd8781fc6a89397b9982bc532db
+  data.tar.gz: 43695d6c3e63d61003cac1ba3b72735ebc9f7e53b7926b4cec186f01d4e5b0d34e466091a0405cb340a846511f788493d9bf7cbd779d8b9c18cfe6900e89c9be

data/README.md

@@ -11,7 +11,7 @@ Dwolla V2 Ruby client. For the V1 Ruby client see [Dwolla/dwolla-ruby](https://g
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dwolla_v2', '~> 0.2'
+gem 'dwolla_v2', '~> 0.4'
 ```
 
 And then execute:
@@ -64,7 +64,8 @@ class YourAuthController < ApplicationController
 
   def auth
     $dwolla.auths.new redirect_uri: "https://yoursite.com/callback",
-                      scope: "ManageCustomers|Funding"
+                      scope: "ManageCustomers|Funding",
+                      state: session[:state] ||= SecureRandom.hex(8)
   end
 end
 ```
@@ -97,21 +98,47 @@ In parallel:
 
 ```ruby
 foo, bar = nil
-
 token.in_parallel do
-  foo = token.get "/foo" # => nil
-  bar = token.get "/bar" # => nil
+  foo = token.get "/foo"
+  bar = token.get "/bar"
 end
+puts foo # only ready after `in_parallel` block has executed
+puts bar # only ready after `in_parallel` block has executed
+```
+
+#### Responses
+
+Requests return a `DwollaV2::Response`.
 
-foo # => { ... }
-bar # => { ... }
+**Response status**:
+
+```ruby
+res = token.post "/customers", customer_params
+res.status # => 201
 ```
 
-Accessing response headers:
+**Response headers**:
 
 ```ruby
 customer = token.post "/customers", customer_params
-customer = token.get customer.headers[:location]
+customer.headers[:location] # => "https://api.dwolla.com/customers/aa76ca27-1920-4a0a-9bbe-a22085c0010e"
+```
+
+**Response body**:
+
+[Enumerable methods](http://ruby-doc.org/core-2.3.0/Enumerable.html), `#==`, and `#[]` are
+forwarded to a response's body. For example:
+
+```ruby
+customer = token.get "/customers/aa76ca27-1920-4a0a-9bbe-a22085c0010e"
+
+customer.collect {|k,v| k }      # => [:_links, :id, ...]
+customer.body.collect {|k,v| k } # => [:_links, :id, ...]
+
+customer == customer.body # => true
+
+customer[:name]      # => John Doe
+customer.body[:name] # => John Doe
 ```
 
 #### Errors
@@ -165,6 +192,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Changelog
 
+- **0.4.0** - Refactor and document how `DwollaV2::Response` works
 - **0.3.1** - better `DwollaV2::Error` error messages
 - **0.3.0** - ISO8601 values in response body are converted to `Time` objects
 - **0.2.0** - Works with `attr_encrypted`

data/lib/dwolla_v2/response.rb

@@ -2,19 +2,23 @@ module DwollaV2
   class Response
     extend Forwardable
 
-    DO_NOT_FORWARD = [:method_missing, :object_id, :__send__]
+    # http://ruby-doc.org/core-2.3.0/Enumerable.html
+    ENUMERABLE = \
+      [:all?, :any?, :chunk, :chunk_while, :collect, :collect_concat, :count, :cycle,
+       :detect, :drop, :drop_while, :each_cons, :each_entry, :each_slice, :each_with_index,
+       :each_with_object, :entries, :find, :find_all, :find_index, :first, :flat_map, :grep,
+       :grep_v, :group_by, :include?, :inject, :lazy, :map, :max, :max_by, :member?, :min,
+       :min_by, :minmax, :minmax_by, :none?, :one?, :partition, :reduce, :reject,
+       :reverse_each, :select, :slice_after, :slice_before, :slice_when, :sort, :sort_by,
+       :take, :take_while, :to_a, :to_h, :zip]
 
-    delegate instance_methods.reject {|m| DO_NOT_FORWARD.include?(m) } => :response_body
-    delegate [:status, :headers] => :@response
+    delegate [:status, :headers, :body] => :@response
+    delegate [*ENUMERABLE, :==, :[]] => :response_body
 
     def initialize response
       @response = response
     end
 
-    def method_missing method, *args, &block
-      response_body.send method, *args, &block
-    end
-
     private
 
     def response_body

data/lib/dwolla_v2/version.rb

@@ -1,3 +1,3 @@
 module DwollaV2
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dwolla_v2
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Stephen Ausman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler