flexirest 1.6.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 395be9d32a66854a03dfee23f11da2773fce4852
-  data.tar.gz: 624db41375f5919e5495eef37d1bb5a2362e3f7e
+  metadata.gz: 59c109cfab49994ec4c27fb6b65745b504f717d3
+  data.tar.gz: 73a93865b5fb49e59a3e080a9a5679e674acf57f
 SHA512:
-  metadata.gz: a6721c8c74d486de9101c54f07909c479416cc49e6838738323c804ea20d82e42f2148dbc218c3ca90d3632b9ebe60bab1cf519a27c1789c6976cb0fa45993d3
-  data.tar.gz: b61cb95703f902fd1bdd26ef2c47fa67a230ff496d39ab30b111b5e9c65546c7f371af8f6c1d0fabd6e8fd584771b200c3b863cb1aeddc7f61e380fe14c290fc
+  metadata.gz: 94809b3ca647b8b60bb155eff4f3defe4b824129a2ba0c3d1525fe2d357799a1ac1f5795e7820112119c36ca702d2b05959f574d14e46a321ac0eba5745049ca
+  data.tar.gz: 776efc1bf75d74c44e197dfef3d8222bb911f57f97e205700b87a847b7191ecd4597b6dbedbffbfac4fec7d932df376b7bb59f5d2634b23175cbc0bf835f4e1b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.6.4
+
+Feature:
+
+- Added the ability to automatically change attributes returned from an API like `SomeName` or `someName` to Ruby-style `some_name` by setting `:rubify_names` when mapping an API call.
+
 ## 1.6.3
 
 Bugfix:

data/CONTRIBUTING.md

@@ -1,14 +1,14 @@
 # Flexirest (ARC) Contributing Guide
 
-## Introduction
+## Introduction
 
 This project was built at Which? Ltd in the UK as ActiveRestClient, but was released as open source in 2014 under the MIT Licence.  This is Andy Jeffries' fork of the project as the original seems not to be maintained by Which? and there's been no communication back about the project.
 
 We're happy to receive contributions from the community for features and bugfixes and hopefully this guide helps new developers to the project to understand how to get started with the internals of Flexirest.
 
-## Overview
+## Overview
 
-![Component Overview Diagram](https://raw.githubusercontent.com/andyjeffries/flexirest/master/doc/Flexirest%20Internals.png)
+![Component Overview Diagram](https://raw.githubusercontent.com/andyjeffries/flexirest/master/docs/Flexirest%20Internals.png)
 
 ## Components
 

data/README.md

@@ -900,7 +900,19 @@ NB: Updating relationships is not yet supported.
 
 ### Proxying APIs
 
-Sometimes you may be working with an old API that returns JSON in a less than ideal format or the URL or parameters required have changed. In this case you can define a descendent of `Flexirest::ProxyBase`, pass it to your model as the proxy and have it rework URLs/parameters on the way out and the response on the way back in (already converted to a Ruby hash/array). By default any non-proxied URLs are just passed through to the underlying connection layer. For example:
+Sometimes you may be working with an old API that returns JSON in a less than ideal format or the URL or parameters required have changed.
+
+If it's simply that you want attribute names like `SomeName` or `someName` to be more Ruby-style `some_name` then you can simply do that by setting `:rubify_names` when mapping an API call.
+
+```ruby
+class Article < Flexirest::Base
+  base_url "http://www.example.com"
+
+  get :all, "/all", rubify_names: true
+end
+```
+
+In more complex cases you can define a descendent of `Flexirest::ProxyBase`, pass it to your model as the proxy and have it rework URLs/parameters on the way out and the response on the way back in (already converted to a Ruby hash/array). By default any non-proxied URLs are just passed through to the underlying connection layer. For example:
 
 ```ruby
 class ArticleProxy < Flexirest::ProxyBase

data/docs/issue_template.md

@@ -0,0 +1,26 @@
+### Expected behaviour
+
+When I use the (something) method, I get this exception xyz...
+
+### Desired behaviour
+
+It should call the remote server correctly and not raise an exception
+
+### How to reproduce
+
+1. Clone the Flexirest repo (`git clone https://github.com/flexirest/flexirest.git`)
+2. Change to the flexirest folder (`cd flexirest`)
+3. Install any dependencies (`bundle install`)
+4. Run an interactive console (`rake c`)
+5. Paste the following:
+
+```ruby
+class MyObject < Flexirest::Base
+  base_url "https://requestb.in"
+  post :create, "/{CREATE_A_PASTEBIN_ID}"
+end
+
+my_object = MyObject.new(params: "something")
+my_object.create
+# => something is output to the terminal
+```

data/lib/flexirest/request.rb

@@ -8,6 +8,7 @@ module Flexirest
   class Request
     include AttributeParsing
     include JsonAPIProxy
+    include ActiveSupport::Inflector
     attr_accessor :post_params, :get_params, :url, :path, :headers, :method, :object, :body, :forced_url, :original_url, :retrying
 
     def initialize(method, object, params = {})
@@ -584,7 +585,11 @@ module Flexirest
       end
 
       attributes.each do |k,v|
-        k = k.to_sym
+        if @method[:options][:rubify_names]
+          k = rubify_name(k)
+        else
+          k = k.to_sym
+        end
         overridden_name = select_name(k, overridden_name)
         if @method[:options][:lazy].include?(k)
           object._attributes[k] = Flexirest::LazyAssociationLoader.new(overridden_name, v, self, overridden_name:(overridden_name))
@@ -756,6 +761,10 @@ module Flexirest
         end
       end
     end
+
+    def rubify_name(k)
+      k.underscore.to_sym
+    end
   end
 
   class RequestException < StandardError ; end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.6.3"
+  VERSION = "1.6.4"
 end

data/spec/lib/request_spec.rb

@@ -32,7 +32,7 @@ describe Flexirest::Request do
       get :find, "/:id", required: [:id]
       get :change, "/change"
       get :plain, "/plain/:id", plain: true
-      post :create, "/create"
+      post :create, "/create", rubify_names: true
       post :test_encoding, "/encoding", request_body_type: :json
       post :testing_no_content_headers, "/no-content"
       put :update, "/put/:id"
@@ -468,6 +468,7 @@ describe Flexirest::Request do
     object.debug = true
     object.only_changed_1
   end
+
   it "should only send changed attributes within the :only_changed array if :only_changed is an array" do
     expect_any_instance_of(Flexirest::Connection).to receive(:patch).with("/changed2", "debug2=true", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"[{\"first_name\":\"Johnny\"}, {\"first_name\":\"Billy\"}, {\"debug\":\"true\"}]", status:200, response_headers:{})))
     object = ExampleClient.new
@@ -478,6 +479,7 @@ describe Flexirest::Request do
     object.debug2 = true
     object.only_changed_2
   end
+
   it "should only send changed attributes marked true within the :only_changed hash when :only_changed is a hash" do
     expect_any_instance_of(Flexirest::Connection).to receive(:patch).with("/changed3", "debug1=false&debug2=true", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"[{\"first_name\":\"Johnny\"}, {\"first_name\":\"Billy\"}, {\"debug\":\"true\"}]", status:200, response_headers:{})))
     object = ExampleClient.new
@@ -489,6 +491,7 @@ describe Flexirest::Request do
     object.debug2 = true
     object.only_changed_3
   end
+
   it "should always send changed attributes marked false within the :only_changed hash when :only_changed is an hash" do
     expect_any_instance_of(Flexirest::Connection).to receive(:patch).with("/changed3", "debug1=true", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"[{\"first_name\":\"Johnny\"}, {\"first_name\":\"Billy\"}, {\"debug\":\"true\"}]", status:200, response_headers:{})))
     object = ExampleClient.new
@@ -499,7 +502,6 @@ describe Flexirest::Request do
     object.only_changed_3
   end
 
-
   it "should instantiate other classes using has_many when required to do so" do
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"first_name\":\"Johnny\", \"expenses\":[{\"amount\":1}, {\"amount\":2}]}", status:200, response_headers:{})))
     object = ExampleClient.all
@@ -536,6 +538,16 @@ describe Flexirest::Request do
     expect(object.id).to eq(1234)
   end
 
+  it "should rubify attribute names" do
+    expect_any_instance_of(Flexirest::Connection).
+      to receive(:post).
+      with("/create", "", an_instance_of(Hash)).
+      and_return(::FaradayResponseMock.new(OpenStruct.new(body:"{\"firstName\":\"John\", \"OtherProperty\":1234}", response_headers:{})))
+    object = ExampleClient.create
+    expect(object.first_name).to eq("John")
+    expect(object.other_property).to eq(1234)
+  end
+
   it "should expose etag if available" do
     response = ::FaradayResponseMock.new(OpenStruct.new(body: "{}", response_headers: {"ETag" => "123456"}, status: 200))
     expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/123", an_instance_of(Hash)).and_return(response)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.6.4
 platform: ruby
 authors:
 - Andy Jeffries
@@ -225,11 +225,12 @@ files:
 - README.md
 - Rakefile
 - Ruby-on-Rails-Integration.md
-- doc/FLEXIREST.svg
-- doc/FLEXIREST@2x.png
-- doc/Flexirest Internals.graffle
-- doc/Flexirest Internals.png
-- doc/Flexirest Logo.sketch
+- docs/FLEXIREST.svg
+- docs/FLEXIREST@2x.png
+- docs/Flexirest Internals.graffle
+- docs/Flexirest Internals.png
+- docs/Flexirest Logo.sketch
+- docs/issue_template.md
 - flexirest.gemspec
 - lib/flexirest.rb
 - lib/flexirest/associations.rb