flexirest 1.2.19 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd0763762a7ac0ddc9a4b65deb81f2351434bb27
-  data.tar.gz: 4c67c29342a607fdddefa1f3685f3694a6ce0f30
+  metadata.gz: bd8c9e532875def5d80496e08867b0f12579dc1d
+  data.tar.gz: f4e81c7652797f5fc3dac4c02870691b2b356583
 SHA512:
-  metadata.gz: 7e68fc41d9dae157ce978fc60990b9394c393c1781858190abc01e0f63570584846cc52f6f9434bc6efab3a3c7c528365f91c575b2dcf3ca6ea109a2b3478640
-  data.tar.gz: b5d25f4aeb33ad3265f690efcabd0cca78687097cd82b133afbcc3095fb61e73be17cf6ec256a72720c95de68b488b84c007a74cac61e10993a0705b0c01326b
+  metadata.gz: 80628e8db4f74a856ba72a017d74f2bbd0225fe4bc5088f06b20e8a7e9b4d6a18f8132ff3adb43b14c2d7fc1e08571c3a3e9a3dc78a0ae3208146eaeb2f4fb19
+  data.tar.gz: 5599b5a95be27c4c391a7cd60654cc0329d32e1f1faad43696b24c4baef0762ec2d907cd945250d74bdedaf50273c2919166e631277754b40986094051420cdc

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.3.1
+
+Features:
+
+- You can now use has_many/has_one on the class live, more like ActiveRecord
+
+## 1.3.0
+
+Features:
+
+- Allow a custom name to be set to be used in logging (thanks to Lewis Buckley)
+
 ## 1.2.19
 
 Features:

data/Migrating-from-ActiveRestClient.md

@@ -0,0 +1,33 @@
+# Migrating from ActiveRestClient
+
+While contracting at Which? Ltd I wrote a library in Ruby to access REST APIs in a very flexible, almost ActiveRecord style. This was agreed (after long discussions with the legal department) to be released as open source.
+
+Unfortunately after leaving Which? the gem was used less and less as I believe they were re-architecting to not rely on backend servers built in Java anymore.
+
+In October 2015 I decided that I didn't want this gem that I'd built to fall by the wayside, so I forked under the name Flexirest (which wasn't listed as a gem at RubyGems.org) and released it.
+
+Since then I've continued to update the library with fixes and some minor new features (it's working really well and is pretty functionally complete, so there isn't much to add there at this point), but some people continue to post bugs/pull requests on the ActiveRestClient GitHub page.
+
+So, if you've seen this link on https://github.com/whichdigital/active-rest-client/ the chances are I've sent you a link to it to show you the reasons why you should switch to Flexirest and how...
+
+## How to change
+
+The first step is to change the line in your Gemfile from:
+
+```ruby
+gem "active-rest-client"  
+```
+
+to read:
+
+```ruby
+gem 'flexirest'  
+```
+
+and then re-run `bundle install`.
+
+The second step is to find and replace across your codebase all instances of `ActiveRestClient` with `Flexirest`.
+
+The third and final step is to clear your Rails cache. The easiest way of doing this is to type `Rails.cache.clear` in a Rails console.
+
+That's it, you've now switched over to Flexirest with a)lots of bug fixes, b)support for PATCH requests and c)someone actively continuing to support it!

data/README.md

@@ -176,6 +176,33 @@ puts @person.expenses.reduce {|e| e.inc_vat}
 puts @person.address.full_string
 ```
 
+You can also use `has_one`/`has_many` on the class level to allow chaining of classes.  You can specify the class name or allow the system to automatically convert it to the singular class. For example:
+
+```ruby
+class Expense < Flexirest::Base
+  def inc_vat
+    ex_vat * 1.20
+  end
+end
+
+class Address < Flexirest::Base
+  def full_string
+    return "#{self.street}, #{self.city}, #{self.region}, #{self.country}"
+  end
+end
+
+class Person < Flexirest::Base
+  has_one :addresses
+  has_many :expenses, Expense
+  get :find, "/people/:id"
+end
+
+class Company < Flexirest::Base
+  has_many :people
+  get :find, "/companies/:id"
+end
+```
+
 Sometimes we want attributes to just return a simple Ruby Array. To achieve this we can add an `:array` option to the method. This is especially useful when the attribute contains an array of scalar values. If you don't specify the `:array` option Flexirest will return a `Flexirest::ResultIterator`. To illustrate the difference consider the following example:
 
 ```ruby

data/lib/flexirest.rb

@@ -1,6 +1,7 @@
 require 'active_support/all'
 require "flexirest/version"
 require "flexirest/attribute_parsing"
+require "flexirest/associations"
 require "flexirest/mapping"
 require "flexirest/caching"
 require "flexirest/logger"
@@ -22,5 +23,12 @@ require "flexirest/base"
 require "flexirest/monkey_patching"
 
 module Flexirest
-  NAME = "Flexirest"
+  @@name = "Flexirest"
+
+  def self.name
+    @@name
+  end
+  def self.name=(value)
+    @@name = value
+  end
 end

data/lib/flexirest/associations.rb

@@ -0,0 +1,57 @@
+module Flexirest
+  module Associations
+    module ClassMethods
+      include ActiveSupport::Inflector
+
+      def has_many(key, klass = nil)
+        if klass.nil?
+          klass = key.to_s.classify.constantize
+        end
+
+        @_associations ||= {}
+        @_associations[key] = klass
+        define_method(key) do
+          unless _attributes[key].is_a?(Array) || _attributes[key].is_a?(Flexirest::ResultIterator)
+            return _attributes[key]
+          end
+
+          if _attributes[key].size == 0
+            return _attributes[key]
+          end
+
+          if _attributes[key][0].is_a?(klass)
+            return _attributes[key]
+          end
+
+          _attributes[key].each_with_index do |v, k|
+            _attributes[key][k] = klass.new(v)
+          end
+
+          _attributes[key]
+        end
+      end
+
+      def has_one(key, klass = nil)
+        if klass.nil?
+          klass = key.to_s.classify.constantize
+        end
+
+        @_associations ||= {}
+        @_associations[key] = klass
+        define_method(key) do
+          if _attributes[key].is_a?(klass)
+            return _attributes[key]
+          end
+
+          _attributes[key] = klass.new(_attributes[key])
+
+          _attributes[key]
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/flexirest/base.rb

@@ -7,6 +7,7 @@ module Flexirest
     include Caching
     include Recording
     include AttributeParsing
+    include Associations
 
     attr_accessor :_status
     attr_accessor :_etag

data/lib/flexirest/caching.rb

@@ -46,7 +46,7 @@ module Flexirest
       def read_cached_response(request)
         if cache_store && perform_caching
           key = "#{request.class_name}:#{request.original_url}"
-          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{key} - Trying to read from cache"
+          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{key} - Trying to read from cache"
           value = cache_store.read(key)
           value = Marshal.load(value) rescue value
         end
@@ -64,7 +64,7 @@ module Flexirest
 
         if cache_store && (headers[:etag] || headers[:expires])
           key = "#{request.class_name}:#{request.original_url}"
-          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{key} - Writing to cache"
+          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{key} - Writing to cache"
           cached_response = CachedResponse.new(status:response.status, result:result)
           cached_response.etag = headers[:etag] if headers[:etag]
           cached_response.expires = Time.parse(headers[:expires]) rescue nil if headers[:expires]

data/lib/flexirest/instrumentation.rb

@@ -3,7 +3,7 @@ module Flexirest
     def request_call(event)
       self.class.time_spent += event.duration
       self.class.calls_made += 1
-      name = '%s (%.1fms)' % [Flexirest::NAME, event.duration]
+      name = '%s (%.1fms)' % [Flexirest.name, event.duration]
       Flexirest::Logger.debug "  \033[1;4;32m#{name}\033[0m #{event.payload[:name]}"
     end
 
@@ -47,7 +47,7 @@ module Flexirest
     module ClassMethods
       def log_process_action(payload)
         messages, time_spent, calls_made = super, payload[:flexirest_time_spent], payload[:flexirest_calls_made]
-        messages << ("#{Flexirest::NAME}: %.1fms for %d calls" % [time_spent.to_f, calls_made]) if calls_made
+        messages << ("#{Flexirest.name}: %.1fms for %d calls" % [time_spent.to_f, calls_made]) if calls_made
         Flexirest::Instrumentation.reset
         messages
       end

data/lib/flexirest/request.rb

@@ -143,7 +143,7 @@ module Flexirest
           if fake.respond_to?(:call)
             fake = fake.call(self)
           end
-          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name} - Faked response found"
+          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Faked response found"
           content_type = @method[:options][:fake_content_type] || "application/json"
           return handle_response(OpenStruct.new(status:200, body:fake, response_headers:{"X-ARC-Faked-Response" => "true", "Content-Type" => content_type}))
         end
@@ -158,10 +158,10 @@ module Flexirest
         cached = original_object_class.read_cached_response(self)
         if cached && !cached.is_a?(String)
           if cached.expires && cached.expires > Time.now
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name} - Absolutely cached copy found"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Absolutely cached copy found"
             return handle_cached_response(cached)
           elsif cached.etag.to_s != "" #present? isn't working for some reason
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}"
             etag = cached.etag
           end
         end
@@ -317,7 +317,7 @@ module Flexirest
         base_url.gsub!(%r{//(.)}, "//#{username}:#{password}@\\1") if username && !base_url[%r{//[^/]*:[^/]*@}]
         connection = Flexirest::ConnectionManager.get_connection(base_url)
       end
-      Flexirest::Logger.info "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}"
+      Flexirest::Logger.info "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}"
 
       if verbose?
         Flexirest::Logger.debug "Flexirest Verbose Log:"
@@ -376,7 +376,7 @@ module Flexirest
       status = @response.status || 200
 
       if cached && response.status == 304
-        Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name}" +
+        Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name}" +
           ' - Etag copy is the same as the server'
         return handle_cached_response(cached)
       end
@@ -386,9 +386,9 @@ module Flexirest
           return @response = response.body
         elsif is_json_response? || is_xml_response?
           if @response.respond_to?(:proxied) && @response.proxied
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"
           else
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest::NAME}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
           end
           result = generate_new_object(ignore_xml_root: @method[:options][:ignore_xml_root])
         else

data/lib/flexirest/version.rb

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

data/spec/lib/associations_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+class AssociationExampleNested < Flexirest::Base
+end
+
+class AssociationExampleOther < Flexirest::Base
+  has_many :nested, AssociationExampleNested
+  has_one :nested_child, AssociationExampleNested
+end
+
+class AssociationExampleBase < Flexirest::Base
+  has_many :others, AssociationExampleOther
+  has_many :association_example_others
+
+  has_one :child, AssociationExampleOther
+  has_one :association_example_other
+end
+
+describe "Has Many Associations" do
+  let(:subject) {AssociationExampleBase.new}
+
+  it "should return the attribute if it's not an iterable type" do
+    subject.others = "foo"
+    expect(subject.others).to eq("foo")
+  end
+
+  it "should return the attribute if it's an empty array" do
+    subject.others = []
+    expect(subject.others).to eq([])
+  end
+
+  it "should return a list of the association class" do
+    subject.others = [{test: "foo"}]
+    expect(subject.others.first).to be_an(AssociationExampleOther)
+  end
+
+  it "should return correctly instantiated association classes" do
+    subject.others = [{test: "foo"}]
+    expect(subject.others.first.test).to eq("foo")
+  end
+
+  it "should automatically guess the association class if possible" do
+    subject.association_example_others = [{test: "foo"}]
+    expect(subject.association_example_others.first.test).to eq("foo")
+  end
+
+  it "should not reinstantiate objects if it's already been called" do
+    subject.others = [AssociationExampleOther.new(test: "foo")]
+    expect(AssociationExampleOther).to_not receive(:new)
+    subject.others
+  end
+
+  it "should return correctly instantiated nested associations" do
+    subject.others = [{nested: [{test: "foo"}]}]
+    expect(subject.others.first.nested.first.test).to eq("foo")
+  end
+end
+
+describe "Has One Associations" do
+  let(:subject) {AssociationExampleBase.new}
+
+  it "should return a list of the association class" do
+    subject.child = {test: "foo"}
+    expect(subject.child).to be_an(AssociationExampleOther)
+  end
+
+  it "should return correctly instantiated association classes" do
+    subject.child = {test: "foo"}
+    expect(subject.child.test).to eq("foo")
+  end
+
+  it "should automatically guess the association class if possible" do
+    subject.association_example_other = {test: "foo"}
+    expect(subject.association_example_other.test).to eq("foo")
+  end
+
+  it "should not reinstantiate objects if it's already been called" do
+    subject.child = AssociationExampleOther.new(test: "foo")
+    expect(AssociationExampleOther).to_not receive(:new)
+    subject.child
+  end
+
+  it "should return correctly instantiated nested associations" do
+    subject.child = {nested_child: {test: "foo"}}
+    expect(subject.child.nested_child.test).to eq("foo")
+  end
+end

data/spec/lib/flexirest_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Flexirest do
+
+  after(:each) do
+    # Reload Module after each test to ensure name variable is reset to default
+    load 'flexirest.rb'
+  end
+
+  it "should be named Flexirest" do
+    expect(Flexirest.name).to eq('Flexirest')
+  end
+
+  it "should allow setting to something else" do
+    Flexirest.name = 'SomethingElse'
+    expect(Flexirest.name).to eq('SomethingElse')
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.2.19
+  version: 1.3.1
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -250,12 +250,14 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE.txt
+- Migrating-from-ActiveRestClient.md
 - README.md
 - Rakefile
 - doc/Flexirest Internals.graffle
 - doc/Flexirest Internals.png
 - flexirest.gemspec
 - lib/flexirest.rb
+- lib/flexirest/associations.rb
 - lib/flexirest/attribute_parsing.rb
 - lib/flexirest/base.rb
 - lib/flexirest/caching.rb
@@ -277,12 +279,14 @@ files:
 - lib/flexirest/result_iterator.rb
 - lib/flexirest/validation.rb
 - lib/flexirest/version.rb
+- spec/lib/associations_spec.rb
 - spec/lib/attribute_parsing_spec.rb
 - spec/lib/base_spec.rb
 - spec/lib/caching_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/connection_manager_spec.rb
 - spec/lib/connection_spec.rb
+- spec/lib/flexirest_spec.rb
 - spec/lib/headers_list_spec.rb
 - spec/lib/instrumentation_spec.rb
 - spec/lib/lazy_association_loader_spec.rb
@@ -317,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource
@@ -325,12 +329,14 @@ summary: This gem is for accessing REST services in a flexible way.  ActiveResou
   Rails conventions, it doesn't have in-built caching and it's not as flexible in
   general.
 test_files:
+- spec/lib/associations_spec.rb
 - spec/lib/attribute_parsing_spec.rb
 - spec/lib/base_spec.rb
 - spec/lib/caching_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/connection_manager_spec.rb
 - spec/lib/connection_spec.rb
+- spec/lib/flexirest_spec.rb
 - spec/lib/headers_list_spec.rb
 - spec/lib/instrumentation_spec.rb
 - spec/lib/lazy_association_loader_spec.rb