flexirest 1.3.22 → 1.3.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29350285d51cfadb0d0bb29a4ad1478a3ed9d0b3
-  data.tar.gz: be31ecfbb8f375e175eb62f6357dc6e2d67b3851
+  metadata.gz: 14a35d637cc44c2743283d3c63c3072b5d46b43c
+  data.tar.gz: a5b9fa6ad5756255d0f7d7033fe7f82ff85927bf
 SHA512:
-  metadata.gz: 90d4c4027ae57dcdf6bac75d9f00284404bd4654aebc00883f4f25aa99a9dc88e72b79b1eb5248206ae02c3b54630d9522c5cea811383109a4558633f1619e32
-  data.tar.gz: 223e2016d360ee3fd7ef70aa7e648c7d7c4a2bc5f33dd3fcf35354c1dae40cd3c2a6f18033690aaf19dd0d52684da238c688a08aec138d863058fb11e7a30ddb
+  metadata.gz: e2e4b418eb542330bcc6223c05ed6335d0727d12a654facf6977e21c639082a066c3e48ffab1bd806a49a1d910a8752799ca351ac9df82dab0cc4331a9bed55b
+  data.tar.gz: 174b86be52593db6abd70544225a2775029c648e03eb4c971e52973a356a31fa304accd0281e7c14f4a167056b369f75843dda5c46fcd38755204360ed11a53b

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - 2.3.0
+  - 2.2.2
   - 2.2.0
   - 2.1.0
   - 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.3.24
+
+Bugfix:
+
+- Calling class methods on an instance where the instance is cacheable should work (thanks to johnmckinght for the bug report)
+
+## 1.3.23
+
+Bugfix:
+
+- Should not parse multiline strings as `DateTime` when using the automatica parsing (thanks to execjosh for the PR)
+
 ## 1.3.22
 
 Bugfix:

data/README.md

@@ -9,6 +9,49 @@
 
 This gem is for accessing REST services in an ActiveRecord style.  ActiveResource already exists for this, but it doesn't work where the resource naming doesn't follow Rails conventions, it doesn't have in-built caching and it's not as flexible in general.
 
+If you are a previous user of ActiveRestClient, there's some more information on [why I created this fork and how to upgrade](https://github.com/flexirest/flexirest/blob/master/Migrating-from-ActiveRestClient.md).
+
+- [Installation](#installation)
+- [Basic Usage](#usage)
+  - [Create a new person](#create-a-new-person)
+  - [Find a person](#find-a-person-not-needed-after-creating)
+  - [Update a person](#update-a-person)
+  - [Get all people](#get-all-people)
+  - [Ruby on Rails Integration](#ruby-on-rails-integration)
+- [Advanced Features](#advanced-features)
+	- [Faraday Configuration](#faraday-configuration)
+	- [Associations](#associations)
+		- [Association Type 1 - Loading Other Classes](#association-type-1-loading-other-classes)
+		- [Association Type 2 - Lazy Loading From Other URLs](#association-type-2-lazy-loading-from-other-urls)
+		- [Association Type 3 - HAL Auto-loaded Resources](#association-type-3-hal-auto-loaded-resources)
+		- [Association Type 4 - Nested Resources](#association-type-4-nested-resources)
+	- [Caching](#caching)
+	- [Using callbacks](#using-callbacks)
+	- [Lazy Loading](#lazy-loading)
+	- [Authentication](#authentication)
+		- [Basic](#basic)
+		- [Api-Auth](#api-auth)
+	- [Body Types](#body-types)
+	- [Parallel Requests](#parallel-requests)
+	- [Faking Calls](#faking-calls)
+	- [Per-request Timeouts](#per-request-timeouts)
+	- [Per-request Params Encoding](#per-request-params-encoding)
+	- [Automatic Conversion of Fields to Date/DateTime](#automatic-conversion-of-fields-to-datedatetime)
+	- [Raw Requests](#raw-requests)
+	- [Plain Requests](#plain-requests)
+	- [Proxying APIs](#proxying-apis)
+	- [Translating APIs](#translating-apis)
+	- [Default Parameters](#default-parameters)
+	- [Root element removal](#root-element-removal)
+	- [Required Parameters](#required-parameters)
+	- [HTTP/Parse Error Handling](#httpparse-error-handling)
+	- [Validation](#validation)
+		- [Permitting nil values](#permitting-nil-values)
+- [Debugging](#debugging)
+- [XML Responses](#xml-responses)
+- [Contributing](#contributing)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -400,7 +443,7 @@ Flexirest::Base.cache_store = Redis::Store.new("redis://localhost:6379/0/cache")
 
 You can use callbacks to alter get/post parameters, the URL or set the post body (doing so overrides normal parameter insertion in to the body) before a request or to adjust the response after a request.  This can either be a block or a named method (like ActionController's `before_callback`/`before_action` methods).
 
-The callback is passed the name of the method (e.g. `:save`) and an object (a request object for `before_request` and a response object for `after_request`). The request object has four public attributes `post_params` (a Hash of the POST parameters), `get_params` (a Hash of the GET parameters), headers and `url` (a String containing the full URL without GET parameters appended)
+The callback is passed the name of the method (e.g. `:save`) and an object (a request object for `before_request` and a response object for `after_request`). The request object has four public attributes `post_params` (a Hash of the POST parameters), `get_params` (a Hash of the GET parameters), `headers` and `url` (a `String` containing the full URL without GET parameters appended).
 
 ```ruby
 require 'secure_random'

data/flexirest.gemspec

@@ -32,6 +32,17 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "multi_json"
   spec.add_runtime_dependency "crack"
-  spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "faraday"
+
+  # Use Gem::Version to parse the Ruby version for reliable comparison
+  # ActiveSupport 5+ requires Ruby 2.2.2
+  if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('2.2.2')
+    spec.add_runtime_dependency "activesupport"
+  else
+    spec.add_runtime_dependency "activesupport", "< 5.0.0"
+  end
+  # JSON is an implicit dependency of something, but JSON v2+ requires Ruby 2+
+  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+    spec.add_runtime_dependency "json", "< 2.0.0"
+  end
 end

data/lib/flexirest/attribute_parsing.rb

@@ -3,9 +3,9 @@ module Flexirest
     private
 
     def parse_attribute_value(v)
-      if v.to_s[(/^(((19|20)\d\d[- \/.](0[1-9]|1[012]|[1-9])[- \/.](0[1-9]|[12][0-9]|3[01]|[1-9]))|((0[1-9]|1[012]|[1-9])[- \/.](0[1-9]|[12][0-9]|3[01]|[1-9])[- \/.](19|20)\d\d))$/)]
+      if v.to_s[(/\A(((19|20)\d\d[- \/.](0[1-9]|1[012]|[1-9])[- \/.](0[1-9]|[12][0-9]|3[01]|[1-9]))|((0[1-9]|1[012]|[1-9])[- \/.](0[1-9]|[12][0-9]|3[01]|[1-9])[- \/.](19|20)\d\d))\Z/)]
         Date.parse(v)
-      elsif v.to_s[/^([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?))$/]
+      elsif v.to_s[/\A([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?))\Z/]
         DateTime.parse(v)
       else
         v

data/lib/flexirest/caching.rb

@@ -68,9 +68,11 @@ module Flexirest
           key = "#{request.class_name}:#{request.original_url}"
           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.etag = "#{headers[:etag]}" if headers[:etag]
           cached_response.expires = Time.parse(headers[:expires]) rescue nil if headers[:expires]
-          cache_store.write(key, Marshal.dump(cached_response), {}) if cached_response.etag.present? || cached_response.expires
+          if cached_response.etag.present? || cached_response.expires
+            cache_store.write(key, Marshal.dump(cached_response), {})
+          end
         end
       end
     end
@@ -82,13 +84,32 @@ module Flexirest
   end
 
   class CachedResponse
-    attr_accessor :status, :result, :etag, :expires
+    attr_accessor :class_name, :status, :etag, :expires
 
     def initialize(options)
       @status = options[:status]
-      @result = options[:result]
       @etag = options[:etag]
       @expires = options[:expires]
+
+      @class_name = options[:result].class.name
+      if options[:result].is_a?(ResultIterator)
+        @class_name = options[:result][0].class.name
+        @result = options[:result].map{|i| {}.merge(i._attributes)}
+      else
+        @result = {}.merge(options[:result].try(:_attributes) || {})
+      end
+    end
+
+    def result
+      return @result if @class_name.nil? # Old cached instance
+
+      if @result.is_a?(Array)
+        ri = ResultIterator.new(self)
+        ri.items = @result.map{|i| @class_name.constantize.new(i)}
+        ri
+      else
+        @class_name.constantize.new(@result)
+      end
     end
   end
 end

data/lib/flexirest/result_iterator.rb

@@ -2,8 +2,8 @@ module Flexirest
   class ResultIterator
     include Enumerable
 
-    attr_accessor :_status
-    attr_reader :items, :_headers
+    attr_accessor :_status, :items
+    attr_reader :_headers
 
     def initialize(response = nil)
       @_status  = response.try :status
@@ -19,6 +19,10 @@ module Flexirest
       @items.size
     end
 
+    def to_a
+      @items
+    end
+
     def index(value)
       @items.index(value)
     end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.3.22"
+  VERSION = "1.3.24"
 end

data/spec/lib/attribute_parsing_spec.rb

@@ -16,10 +16,18 @@ describe Flexirest::AttributeParsing do
     expect(subject.test("1980-12-24T00:00:00.000Z")).to be_a(DateTime)
   end
 
+  it "should not parse a multiline string as a datetime" do
+    expect(subject.test("not a datetime\n1980-12-24T00:00:00.000Z")).to be_a(String)
+  end
+
   it "should parse dates" do
     expect(subject.test("1980-12-24")).to be_a(Date)
   end
 
+  it "should not parse a multiline string as a datetime" do
+    expect(subject.test("not a date\n1980-12-24")).to be_a(String)
+  end
+
   it "should return strings for string values" do
     expect(subject.test("1980-12")).to eq("1980-12")
   end

data/spec/lib/base_spec.rb

@@ -37,6 +37,11 @@ class NonHostnameBaseUrlExample < Flexirest::Base
   get :all, "/all"
 end
 
+class InstanceMethodExample < Flexirest::Base
+  base_url "http://www.example.com/v1/"
+  get :all, "/all"
+end
+
 describe Flexirest::Base do
   it 'should instantiate a new descendant' do
     expect{EmptyExample.new}.to_not raise_error
@@ -345,6 +350,21 @@ describe Flexirest::Base do
       end
     end
 
+    it "should work with caching if instance methods are used" do
+      perform_caching = InstanceMethodExample.perform_caching
+      cache_store = InstanceMethodExample.cache_store
+      begin
+        response = "{\"id\": 1, \"name\":\"test\"}"
+        allow_any_instance_of(Flexirest::Connection).to receive(:get).and_return(            ::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{"Etag" => "12345678", "Content-type" => "application/json"}, body:response)))
+        e = InstanceMethodExample.new
+        e.all(1)
+        expect(e.id).to eq(1)
+      ensure
+        InstanceMethodExample.perform_caching = perform_caching
+        InstanceMethodExample.cache_store = cache_store
+      end
+    end
+
     it "should be able to lazy load a direct URL request" do
       expect_any_instance_of(Flexirest::Request).to receive(:do_request).with(any_args).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:"{\"first_name\":\"Billy\"}")))
       example = EmptyExample._lazy_request("http://api.example.com/")
@@ -409,7 +429,6 @@ describe Flexirest::Base do
       expect(json_parsed_object["students"].first["age"]).to eq(student1.age)
       expect(json_parsed_object["students"].second["age"]).to eq(student2.age)
     end
-
   end
 
 end

data/spec/lib/caching_spec.rb

@@ -82,9 +82,9 @@ describe Flexirest::Caching do
         def write(key, value, options={}) ; end
       end
 
-      expect{ Flexirest::Base.cache_store = CachingExampleCacheStore2.new }.to raise_error
-      expect{ Flexirest::Base.cache_store = CachingExampleCacheStore3.new }.to raise_error
-      expect{ Flexirest::Base.cache_store = CachingExampleCacheStore4.new }.to raise_error
+      expect{ Flexirest::Base.cache_store = CachingExampleCacheStore2.new }.to raise_error(Flexirest::InvalidCacheStoreException)
+      expect{ Flexirest::Base.cache_store = CachingExampleCacheStore3.new }.to raise_error(Flexirest::InvalidCacheStoreException)
+      expect{ Flexirest::Base.cache_store = CachingExampleCacheStore4.new }.to raise_error(Flexirest::InvalidCacheStoreException)
     end
 
     it "should allow you to remove the custom cache store" do

data/spec/lib/connection_spec.rb

@@ -149,7 +149,6 @@ describe Flexirest::Connection do
 
     if  Gem.loaded_specs["api-auth"].present? && Gem.loaded_specs["api-auth"].version.to_s >= "2.0.0"
       it 'should have an Authorization header with a custom digest method' do
-        puts Gem.loaded_specs["api-auth"].version
         @options[:api_auth][:api_auth_options] = {
           digest: "sha256"
         }

data/spec/lib/logger_spec.rb

@@ -45,9 +45,10 @@ describe Flexirest::Instrumentation do
     expect(File).to receive(:open).with("/dev/null", "a").and_yield(file)
     expect(file).to receive(:<<).with("Hello warn\n")
     Flexirest::Logger.warn("Hello warn")
+    Flexirest::Logger.logfile = nil
   end
 
-  it "should write to a logfile if one has been specified" do
+  it "should write to STODOUT if one has been specified" do
     Flexirest::Logger.logfile = STDOUT
     expect(STDOUT).to receive(:<<).with("Hello world\n")
     Flexirest::Logger.debug("Hello world")
@@ -60,6 +61,7 @@ describe Flexirest::Instrumentation do
 
     expect(STDOUT).to receive(:<<).with("Hello warn\n")
     Flexirest::Logger.warn("Hello warn")
+    Flexirest::Logger.logfile = nil
   end
 
   it "should append to its own messages list if neither Rails nor a logfile has been specified" do

data/spec/lib/result_iterator_spec.rb

@@ -120,7 +120,7 @@ describe Flexirest::ResultIterator do
   it "raises an error if you call paginate without WillPaginate installed" do
     result = Flexirest::ResultIterator.new
     result << 3
-    expect{result.paginate}.to raise_error
+    expect{result.paginate}.to raise_error(Flexirest::WillPaginateNotAvailableException)
   end
 
   it "returns a WillPaginate::Collection if you call paginate with WillPaginate installed" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.3.22
+  version: 1.3.24
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-24 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +193,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="