flexirest 1.2.18 → 1.2.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 951a773aca32f3710bae2ee3ed2f4a34c4ee9232
-  data.tar.gz: d0857284056ec1f1c6b563e1d67f92c8fcae81bd
+  metadata.gz: bd0763762a7ac0ddc9a4b65deb81f2351434bb27
+  data.tar.gz: 4c67c29342a607fdddefa1f3685f3694a6ce0f30
 SHA512:
-  metadata.gz: 29904f4d2b02428fbb1d056667c3ade2bf42cae9f859e4f328c4cd3ebde47a57160f6c8df00fab0f4967e23cc734bbd26f27e54714b6ebbdb4b46a53986f92fa
-  data.tar.gz: bf945048697c7dc7aa235cc4ef4fffe6a5d6260731d806395f413b797f05e95aa4b1d5f1ab9d1b58f02880bf5c53dd3ca5a14bf4dda1a0673eba34d7c4eac522
+  metadata.gz: 7e68fc41d9dae157ce978fc60990b9394c393c1781858190abc01e0f63570584846cc52f6f9434bc6efab3a3c7c528365f91c575b2dcf3ca6ea109a2b3478640
+  data.tar.gz: b5d25f4aeb33ad3265f690efcabd0cca78687097cd82b133afbcc3095fb61e73be17cf6ec256a72720c95de68b488b84c007a74cac61e10993a0705b0c01326b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.19
+
+Features:
+
+- Allow procs in defaults to be able to use params (for Michael Mealling)
+
 ## 1.2.18
 
 Features:

data/README.md

@@ -746,6 +746,19 @@ end
 @people = Person.all(active:false)
 ```
 
+If you specify `defaults` as a `Proc` this will be executed with the set parameters (which you can change). For example to allow you to specify a reference (but the API wants it formated as "id-reference") you could use:
+
+```ruby
+class Person < Flexirest::Base
+  get :all, "/", defaults: (Proc.new do |params|
+    reference = params.delete(:reference) # Delete the old parameter
+    {
+      id: "id-#{reference}"
+    } # The last thing is the hash of defaults
+  end)
+end
+```
+
 ### Required Parameters
 
 If you want to specify that certain parameters are required for a specific call, you can specify them like:

data/lib/flexirest/request.rb

@@ -215,7 +215,11 @@ module Flexirest
         params = {id:params}
       end
 
-      default_params = @method[:options][:defaults] || {}
+      if @method[:options][:defaults].respond_to?(:call)
+        default_params = @method[:options][:defaults].call(params)
+      else
+        default_params = @method[:options][:defaults] || {}
+      end
 
       if @explicit_parameters
         params = @explicit_parameters
@@ -519,7 +523,7 @@ module Flexirest
       if @method[:options][:has_many][name] || @method[:options][:has_one][name]
         return name
       end
-      
+
       parent_name || name
     end
 

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.2.18"
+  VERSION = "1.2.19"
 end

data/spec/lib/request_spec.rb

@@ -48,6 +48,16 @@ describe Flexirest::Request do
       get :all, "/"
     end
 
+    class ProcDefaultExampleClient < Flexirest::Base
+      base_url "http://www.example.com"
+      get :all, "/", defaults: (Proc.new do |params|
+        reference = params.delete(:reference)
+        {
+          id: "id-#{reference}"
+        }
+      end)
+    end
+
     class LazyLoadedExampleClient < ExampleClient
       base_url "http://www.example.com"
       lazy_load!
@@ -115,6 +125,11 @@ describe Flexirest::Request do
     ExampleClient.defaults overwrite:"yes"
   end
 
+  it "should pass through get parameters, calling the proc if one is specified for defaults" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/?id=id-123456", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    ProcDefaultExampleClient.all reference:"123456"
+  end
+
   it "should ensure any required parameters are specified" do
     expect_any_instance_of(Flexirest::Connection).to_not receive(:get)
     expect{ExampleClient.requires}.to raise_error(Flexirest::MissingParametersException)
@@ -262,7 +277,7 @@ describe Flexirest::Request do
     expect(object[1].first_name).to eq("Billy")
     expect(object._status).to eq(200)
   end
-  
+
   it "should parse an attribute to be an array if attribute included in array option" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/johnny", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"likes\":[\"donuts\", \"bacon\"], \"dislikes\":[\"politicians\", \"lawyers\", \"taxes\"]}", status:200, response_headers:{})))
     object = ExampleClient.array

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.2.18
+  version: 1.2.19
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler