spyke 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00c19525c5f1a175a8bb69815c18493d61a0ae9c
-  data.tar.gz: f3b903bd7a4ae21e974fe3a1a77e75adff7c104a
+SHA256:
+  metadata.gz: 7de3203151c0bbf40af24c4ebb7926f60b497e61cd4a7edd3d5b0dcc12f302e5
+  data.tar.gz: 9cea6becd607f2f4a74258a5984055e619206f0df881c56fb444716e6e91b8af
 SHA512:
-  metadata.gz: 23693dddb0c0b1f7f5afc44b7015de2eb4e1fbd28ae847685690ddf0f5c957a1f0cee01e63566827f987ee95d84aab6ea1b9019145f98ba3aaa397a53fbe899b
-  data.tar.gz: 10d722d8f55f915520a2c95a42e9545afe712599a6a8c8859674ded1f7548582f759eee2f285a18882aaa691aeda55b2eb7f0d9ee4cacbae4f9a4c667442a92f
+  metadata.gz: db5b33e37fe25bc7f2f56215ca904a37c40541804acaa8338c9b63d23ac10e9e7724f65b6abf4ac98501b354fd1d802cd0bff0483b3a2b64673797d299043750
+  data.tar.gz: 34252e5c0e56a6b7a3fc83343ed955d39f6dc46250da3c8e90817df01609adcb9e09105cc9bb6b96bfd4b8c66bf06d3dbcbc20fbf4ccc7cd11ef016800019c5a

data/.travis.yml

@@ -1,5 +1,5 @@
 notifications:
   email: false
 rvm:
-  - 2.3.1
+  - 2.6.6
 sudo: false

data/README.md

@@ -1,12 +1,11 @@
 # Spyke
 
 <p align="center">
-  <img src="http://upload.wikimedia.org/wikipedia/en/thumb/2/21/Spyke.jpg/392px-Spyke.jpg" width="20%" />
+  <img src="http://upload.wikimedia.org/wikipedia/en/thumb/2/21/Spyke.jpg/392px-Spyke.jpg" width="15%" />
   <br/>
   Interact with remote <strong>REST services</strong> in an <strong>ActiveRecord-like</strong> manner.
   <br /><br />
   <a href="https://rubygems.org/gems/spyke"><img src="https://badge.fury.io/rb/spyke.svg?style=flat" alt="Gem Version"></a>
-  <a href='https://gemnasium.com/balvig/spyke'><img src="https://gemnasium.com/balvig/spyke.svg" /></a>
   <a href="https://codeclimate.com/github/balvig/spyke"><img src="https://codeclimate.com/github/balvig/spyke/badges/gpa.svg" /></a>
   <a href='https://coveralls.io/r/balvig/spyke?branch=master'><img src='https://img.shields.io/coveralls/balvig/spyke.svg?style=flat' /></a>
   <a href="https://travis-ci.org/balvig/spyke"><img src="https://travis-ci.org/balvig/spyke.svg?branch=master" /></a>
@@ -31,6 +30,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'spyke'
+gem 'multi_json' # or whatever is needed to parse responses
 ```
 
 Spyke uses Faraday to handle requests and expects it to parse the response body into a hash in the following format:
@@ -153,6 +153,19 @@ Post.request(:post, 'posts/3/log', time: '12:00')
 # => POST http://api.com/posts/3/log - { time: '12:00' }
 ```
 
+### Custom primary keys
+
+Custom primary keys can be defined with `self.primary_key = :custom_key`:
+
+```ruby
+class User < Spyke::Base
+  self.primary_key = :user_id
+
+  # When using custom URIs the :id parameter also has to be adjusted
+  uri 'people(/:user_id)'
+end
+```
+
 ### API-side validations
 
 Spyke expects errors to be formatted in the same way as the

data/lib/spyke/attribute_assignment.rb

@@ -6,7 +6,6 @@ module Spyke
     extend ActiveSupport::Concern
 
     included do
-      attr_reader :attributes
       delegate :[], :[]=, to: :attributes
     end
 
@@ -40,11 +39,19 @@ module Spyke
       yield self if block_given?
     end
 
+    def attributes
+      @spyke_attributes
+    end
+
     def attributes=(new_attributes)
-      @attributes ||= Attributes.new(scope.params)
+      @spyke_attributes ||= Attributes.new(scope.params)
       use_setters(new_attributes) if new_attributes
     end
 
+    def id?
+      id.present?
+    end
+
     def id
       attributes[primary_key]
     end

data/lib/spyke/http.rb

@@ -41,20 +41,20 @@ module Spyke
         @uri ||= uri_template || default_uri
       end
 
-      private
-
-        def send_request(method, path, params)
-          connection.send(method) do |request|
-            if method == :get
-              request.url path.to_s, params
-            else
-              request.url path.to_s
-              request.body = params
-            end
+      def send_request(method, path, params)
+        connection.send(method) do |request|
+          if method == :get
+            request.url path.to_s, params
+          else
+            request.url path.to_s
+            request.body = params
           end
-          rescue Faraday::ConnectionFailed, Faraday::TimeoutError
-            raise ConnectionError
         end
+        rescue Faraday::ConnectionFailed, Faraday::TimeoutError
+          raise ConnectionError
+      end
+
+      private
 
         def scoped_request(method)
           uri = new.uri
@@ -79,7 +79,7 @@ module Spyke
         end
 
         def default_uri
-          "#{model_name.element.pluralize}/(:#{primary_key})"
+          "#{model_name.element.pluralize}(/:#{primary_key})"
         end
     end
 

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '5.3.0'
+  VERSION = '5.4.0'
 end

data/spyke.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport', '>= 4.0.0', '< 6.0'
-  spec.add_dependency 'activemodel', '>= 4.0.0', '< 6.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'activemodel', '>= 4.0.0'
   spec.add_dependency 'faraday', '>= 0.9.0', '< 2.0'
   spec.add_dependency 'faraday_middleware', '>= 0.9.1', '< 2.0'
   spec.add_dependency 'addressable', '>= 2.5.2'

data/test/activemodel_dirty_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+module Spyke
+  class ActiveModelDirtyTest < MiniTest::Test
+    def test_attributes_instance_var_compatibility
+      recipe = RecipeWithDirty.new(title: 'Cheeseburger')
+
+      # If @attributes is set on recipe ActiveModel::Dirty will crash
+      assert_equal false, recipe.attribute_changed_in_place?(:title)
+    end
+  end
+end

data/test/attributes_test.rb

@@ -135,9 +135,9 @@ module Spyke
 
     def test_inspect
       recipe = Recipe.new(id: 2, title: 'Pizza', description: 'Delicious')
-      assert_equal '#<Recipe(recipes/(:id)) id: 2 title: "Pizza" description: "Delicious">', recipe.inspect
+      assert_equal '#<Recipe(recipes(/:id)) id: 2 title: "Pizza" description: "Delicious">', recipe.inspect
       recipe = Recipe.new
-      assert_equal '#<Recipe(recipes/(:id)) id: nil >', recipe.inspect
+      assert_equal '#<Recipe(recipes(/:id)) id: nil >', recipe.inspect
       user = Recipe.new.build_user
       assert_equal '#<User(users/:uuid) id: nil >', user.inspect
       group = Recipe.new.groups.build

data/test/config_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+module Spyke
+  class ConfigConnectionWarnTest < MiniTest::Test
+    def test_config_connection_warn
+      assert_output '', "[DEPRECATION] `Spyke::Config.connection=` is deprecated.  Please use `Spyke::Base.connection=` instead.\n" do
+        Spyke::Config.connection = Spyke::Base.connection
+      end
+    end
+  end
+end

data/test/custom_request_test.rb

@@ -63,9 +63,16 @@ module Spyke
     end
 
     def test_multiple_apis
-      endpoint = stub_request(:get, 'http://sashimi.com/other_recipes')
+      endpoint = stub_request(:get, 'http://sashimi.com/recipes')
       OtherRecipe.all.to_a
       assert_requested endpoint
     end
+
+    def test_multiple_apis_with_custom_fallback
+      fallback_endpoint = stub_request(:get, 'http://sushi.com/recipes')
+      primary_endpoint = stub_request(:get, 'http://sashimi.com/recipes').to_timeout
+      OtherRecipe.all.to_a
+      assert_requested fallback_endpoint
+    end
   end
 end

data/test/orm_test.rb

@@ -206,5 +206,13 @@ module Spyke
       assert_equal 1, user[:uuid]
       assert_equal 42, user[:id]
     end
+
+    def test_custom_primary_key_used_for_persistence_check
+      user = User.new
+      refute user.persisted?
+
+      user.uuid = 1
+      assert user.persisted?
+    end
   end
 end

data/test/support/fixtures.rb

@@ -116,7 +116,15 @@ class OtherApi < Spyke::Base
   end
 end
 
-class OtherRecipe < OtherApi; end
+class OtherRecipe < OtherApi
+  uri 'recipes/(:id)'
+
+  def self.send_request(method, path, params)
+    super
+  rescue Spyke::ConnectionError
+    Recipe.send_request(method, path, params)
+  end
+end
 
 class Search
   def initialize(query)
@@ -152,3 +160,10 @@ module Cookbook
     include_root_in_json :foto
   end
 end
+
+class RecipeWithDirty < Recipe
+  # NOTE: Simply including ActiveModel::Dirty doesn't provide all the dirty
+  # functionality. This is left intentionally incomplete as it's all we need
+  # for testing compatibility.
+  include ActiveModel::Dirty
+end

data/test/test_helper.rb

@@ -9,7 +9,7 @@ end
 require 'spyke'
 require 'minitest/autorun'
 require 'minitest/reporters'
-require 'mocha/mini_test'
+require 'mocha/minitest'
 require 'multi_json'
 require 'pry'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Jens Balvig
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-02 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +31,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -257,7 +245,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - lib/spyke.rb
 - lib/spyke/associations.rb
 - lib/spyke/associations/association.rb
@@ -285,9 +272,11 @@ files:
 - lib/spyke/scoping.rb
 - lib/spyke/version.rb
 - spyke.gemspec
+- test/activemodel_dirty_test.rb
 - test/associations_test.rb
 - test/attributes_test.rb
 - test/callbacks_test.rb
+- test/config_test.rb
 - test/custom_request_test.rb
 - test/fallbacks_test.rb
 - test/orm_test.rb
@@ -300,7 +289,7 @@ homepage: https://github.com/balvig/spyke
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -315,15 +304,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Interact with REST services in an ActiveRecord-like manner
 test_files:
+- test/activemodel_dirty_test.rb
 - test/associations_test.rb
 - test/attributes_test.rb
 - test/callbacks_test.rb
+- test/config_test.rb
 - test/custom_request_test.rb
 - test/fallbacks_test.rb
 - test/orm_test.rb

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  ruby:
-    version: 2.2.2