spyke 5.3.1 → 5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a8f605cd12c22641c85ffdaf643cead8ef8eab997e347075596a7b7c9149e0c
-  data.tar.gz: 97caf4cac49eb5e66164193845e5a5bb60069cc910f349de38eaf01e0d7fd57c
+  metadata.gz: 46c56a1975e770acc9b1e9d40abdfbfd7d59b15705da333d293d0ecb18678628
+  data.tar.gz: bbc4a65e7cc6293ce9e93410eae69dd4003ede73364207c17bff79c1736770a2
 SHA512:
-  metadata.gz: 1afad1b576ca01dd62b642da238ad80f2048da50a73ca387ed8df541a005601ba55a2c4769c881e991f79d40adbfa0992377989881dc49ce12c58174265ffd36
-  data.tar.gz: 6e99ad81b53c136acadb85bc5363510067cb7704bbdc74a8ad1c84c0b79ff0079ac5029e5aa6aa65b74e24446068d01e568fb4258080bdf4202ccb4c75303be9
+  metadata.gz: 6e741d1302b7a404d2f052329814b74af2aab61f17a5edff94b06f1bb5fadf78a8bbb43c93dbd2ed4a48064721dad8e57a28d53fde35b5d14f7a44f19fe01a31
+  data.tar.gz: 9a7cbdf9fd0b504c9772dd5388ff949b1ab5abe666277e11efc8e347e3aae22e5337cba0b506388f90f9cc2b68f5ddb97bf4dd8b08b50694a43e1f2d99c32a9a

data/.travis.yml

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

data/README.md

@@ -1,7 +1,7 @@
 # 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 />
@@ -30,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:
@@ -152,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
@@ -76,7 +83,7 @@ module Spyke
         # Set id attribute directly if using a custom primary key alongside an attribute named "id" to avoid clobbering
         set_attribute :id, attributes.delete(:id) if conflicting_ids?(attributes)
 
-        attributes.each do |key, value|
+        attributes.to_h.each do |key, value|
           send "#{key}=", value
         end
       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

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '5.3.1'
+  VERSION = '5.4.1'
 end

data/spyke.gemspec

@@ -18,12 +18,13 @@ 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'
 
+  spec.add_development_dependency 'actionpack', '>= 4.0.0'
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'minitest'

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/associations_test.rb

@@ -301,6 +301,22 @@ module Spyke
       assert_equal %w{ starter sauce }, recipe.groups.map(&:title)
     end
 
+    def test_nested_attributes_has_one_using_strong_params
+      recipe = Recipe.new(image_attributes: strong_params(file: 'bob.jpg').permit!)
+      assert_equal 'bob.jpg', recipe.image.file
+    end
+
+    def test_nested_attributes_belongs_to_using_strong_params
+      recipe = Recipe.new(user_attributes: strong_params({ name: 'Bob' }).permit!)
+      assert_equal 'Bob', recipe.user.name
+    end
+
+    def test_nested_attributes_has_many_using_strong_params
+      params = strong_params(groups_attributes: [strong_params(title: 'starter').permit!, strong_params(title: 'sauce').permit!]).permit!
+      recipe = Recipe.new(params)
+      assert_equal %w{ starter sauce }, recipe.groups.map(&:title)
+    end
+
     def test_nested_attributes_replacing_existing_when_no_ids_present
       recipe = Recipe.new(groups_attributes: [{ title: 'starter' }, { title: 'sauce' }])
       recipe.attributes = { groups_attributes: [{ title: 'flavor' }] }
@@ -325,6 +341,17 @@ module Spyke
       assert_equal %w{ starter sauce }, recipe.groups.map(&:title)
     end
 
+    def test_nested_attributes_has_many_using_strong_params_with_hash_syntax
+      params = strong_params(
+        groups_attributes: strong_params(
+          '0' => strong_params(title: 'starter').permit!,
+          '1' => strong_params(title: 'sauce').permit!,
+        ).permit!
+      ).permit!
+      recipe = Recipe.new(params)
+      assert_equal %w{ starter sauce }, recipe.groups.map(&:title)
+    end
+
     def test_deeply_nested_attributes_has_many_using_array_syntax
       params = { groups_attributes: [{ id: 1, ingredients_attributes: [{ id: 1, name: 'Salt' }, { id: 2, name: 'Pepper' } ]}] }
       recipe = Recipe.new(params)
@@ -357,6 +384,40 @@ module Spyke
       assert_equal %w{ Salt Pepper }, recipe.ingredients.map(&:name)
     end
 
+    def test_deeply_nested_attributes_has_many_using_strong_params_with_array_syntax
+      params = strong_params(
+        groups_attributes: [
+          strong_params(
+            ingredients_attributes: [
+              strong_params(id: '', name: 'Salt').permit!,
+              strong_params(id: '', name: 'Pepper').permit!,
+            ]
+          ).permit!
+        ]
+      ).permit!
+      recipe = Recipe.new(params)
+      assert_equal %w{ Salt Pepper }, recipe.ingredients.map(&:name)
+      recipe.attributes = params
+      assert_equal %w{ Salt Pepper }, recipe.ingredients.map(&:name)
+    end
+
+    def test_deeply_nested_attributes_has_many_using_strong_params_with_hash_syntax
+      params = strong_params(
+        groups_attributes: strong_params(
+          '0' => strong_params(
+            ingredients_attributes: strong_params(
+              '0' => strong_params(id: '', name: 'Salt').permit!,
+              '1' => strong_params(id: '', name: 'Pepper').permit!,
+            ).permit!
+          ).permit!
+        ).permit!
+      ).permit!
+      recipe = Recipe.new(params)
+      assert_equal %w{ Salt Pepper }, recipe.ingredients.map(&:name)
+      recipe.attributes = params
+      assert_equal %w{ Salt Pepper }, recipe.ingredients.map(&:name)
+    end
+
     def test_reflect_on_association
       assert_equal Group, Recipe.reflect_on_association(:group).klass
       assert_equal Cookbook::Like, Cookbook::Tip.reflect_on_association(:like).klass

data/test/attributes_test.rb

@@ -11,6 +11,18 @@ module Spyke
       assert_equal 'Tasty', recipe.description
     end
 
+    def test_initializing_using_permitted_strong_params
+      ingredient = Ingredient.new(strong_params(name: 'Flour').permit!)
+
+      assert_equal 'Flour', ingredient.name
+    end
+
+    def test_initializing_using_unpermitted_strong_params
+      assert_raises ActionController::UnfilteredParameters do
+        Ingredient.new(strong_params(name: 'Flour'))
+      end
+    end
+
     def test_to_params
       attr = Attributes.new(id: 3, 'title' => 'Fish', groups: [ Group.new(name: 'Starter'), { name: 'Dessert' } ])
       assert_equal({ 'id' => 3 , 'title' => 'Fish', 'groups' => [{ 'name' => 'Starter' }, { 'name' => 'Dessert' }] }, attr.to_params)

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

@@ -54,6 +54,22 @@ module Spyke
       assert_requested endpoint
     end
 
+    def test_save_hash_attribute
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { meta: { foo: 'bar' } } })
+
+      Recipe.create(meta: { foo: 'bar' })
+
+      assert_requested endpoint
+    end
+
+    def test_save_hash_attribute_with_strong_params
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { meta: { foo: 'bar' } } })
+
+      Recipe.create(strong_params(meta: { foo: 'bar' }).permit!)
+
+      assert_requested endpoint
+    end
+
     def test_update_attributes
       endpoint = stub_request(:put, 'http://sushi.com/recipes/1').with(body: { recipe: { title: 'Sushi' } }).to_return_json(result: { id: 1, title: 'Sushi (saved)' })
 
@@ -206,5 +222,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'
 
@@ -18,3 +18,10 @@ Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
 
 # Pretty colors
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+# For testing strong params
+require 'action_controller/metal/strong_parameters'
+
+def strong_params(params)
+  ActionController::Parameters.new(params)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 5.4.1
 platform: ruby
 authors:
 - Jens Balvig
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2021-02-25 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
@@ -104,6 +92,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.2
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -257,7 +259,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- circle.yml
 - lib/spyke.rb
 - lib/spyke/associations.rb
 - lib/spyke/associations/association.rb
@@ -285,9 +286,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 +303,7 @@ homepage: https://github.com/balvig/spyke
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -315,15 +318,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-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