spyke 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a430604d1097764cd8add4c5b0f44161e5939d4
-  data.tar.gz: af8c8efb25d69ee8555510408edc393b5f8d1e5d
+  metadata.gz: 5862d16d060c727c750f6ef6fa7f785d729747f5
+  data.tar.gz: '09585cb44ae03a6fda4c919d04ec24175dc55392'
 SHA512:
-  metadata.gz: 805690aac305cad08aeb0d8f34a63ca17aab8296080d42c51cb9f23117679592c3e8e1addf867595e2d1f82e19ad7607a06b1e2b6c8adf99b7dd4c2a3625d551
-  data.tar.gz: 8337033aea0abef30be2ce84d83e80c947ee643eb3a0214fb6637f8a1404b36c5f1f67c7d02e06b0429aa027010d737aa8a705f9bf92c6cc87d6a199b886892b
+  metadata.gz: 3fba59829a12e29b2b8290f8aaa6a75fff77ecd274c11a32a46e60797d61f4fcfd08ff24cb9b36083f6c248367778e8668613e69289b7d89b22b98c32d19b3eb
+  data.tar.gz: b4ff64f835373b9bb7eaeda69d3d67e29ead1926dbf4fecbdd745f0a2409164d1d5ebb3778ac9d9dee6bf907ea2981a1863bf7d0aa1841ff13cf99cb54747f76

data/README.md

@@ -91,7 +91,7 @@ user = User.find(3)
 # => GET http://api.com/users/3
 
 user.posts
-# => find embedded in returned JSON or GET http://api.com/users/3/posts
+# => find embedded in returned data or GET http://api.com/users/3/posts
 
 user.update(name: 'Alice')
 # => PUT http://api.com/users/3 - { user: { name: 'Alice' } }
@@ -106,22 +106,22 @@ User.create(name: 'Bob')
 ### Custom URIs
 
 You can specify custom URIs on both the class and association level.
-Set uri to `nil` for associations you only want to use embedded JSON
-and never call out to the API.
+Set uri to `nil` for associations you only want to use data embedded
+in the response and never call out to the API.
 
 ```ruby
 class User < Spyke::Base
-  uri 'people/(:id)' # id optional, both /people and /people/4 are valid
+  uri 'people(/:id)' # id optional, both /people and /people/4 are valid
 
   has_many :posts, uri: 'posts/for_user/:user_id' # user_id is required
-  has_one :image, uri: nil # only use embedded JSON
+  has_one :image, uri: nil # only use embedded data
 end
 
 class Post < Spyke::Base
 end
 
 user = User.find(3) # => GET http://api.com/people/3
-user.image # Will only use embedded JSON and never call out to api
+user.image # Will only use embedded data and never call out to api
 user.posts # => GET http://api.com/posts/for_user/3
 Post.find(4) # => GET http://api.com/posts/4
 ```

data/lib/spyke/attribute_assignment.rb

@@ -15,7 +15,7 @@ module Spyke
       # they become overridable with "super".
       # http://thepugautomatic.com/2013/07/dsom/
       def attributes(*names)
-        unless @spyke_instance_method_container
+        unless instance_variable_defined?(:@spyke_instance_method_container)
           @spyke_instance_method_container = Module.new
           include @spyke_instance_method_container
         end
@@ -25,6 +25,10 @@ module Spyke
             define_method(name) do
               attribute(name)
             end
+
+            define_method(:"#{name}=") do |value|
+              set_attribute(name, value)
+            end
           end
         end
       end

data/lib/spyke/path.rb

@@ -1,9 +1,9 @@
-require 'uri_template'
+require 'addressable/template'
+require 'spyke/rfc_converter'
 
 module Spyke
   class InvalidPathError < StandardError; end
   class Path
-
     def initialize(pattern, params = {})
       @pattern = pattern
       @params = params.symbolize_keys
@@ -24,36 +24,40 @@ module Spyke
     private
 
       def uri_template
-        @uri_template ||= URITemplate.new(:colon, pattern_with_rfc_style_parens)
+        @uri_template ||= Addressable::Template.new(pattern_with_rfc_style_parens)
       end
 
       def pattern_with_rfc_style_parens
-        @pattern.gsub('(', '{').gsub(')', '}')
+        RfcConverter.new(@pattern).convert
       end
 
       def path
-        validate_required_params!
-        uri_template.expand(@params).chomp('/')
+        validate_required_variables!
+        uri_template.expand(@params).to_s.chomp('/')
       end
 
-      def validate_required_params!
-        if missing_required_params.any?
-          raise Spyke::InvalidPathError, "Missing required params: #{missing_required_params.join(', ')} in #{@pattern}. Mark optional params with parens eg: (:param)"
+      def validate_required_variables!
+        if missing_required_variables.any?
+          raise Spyke::InvalidPathError, "Missing required variables: #{missing_required_variables.join(', ')} in #{@pattern}. Mark optional variables with parens eg: (:param)"
         end
       end
 
-      def missing_required_params
-        required_params - params_with_values
+      def missing_required_variables
+        required_variables - variables_with_values
       end
 
-      def params_with_values
+      def variables_with_values
         @params.map do |key, value|
           key if value.present?
         end.compact
       end
 
-      def required_params
-        @pattern.scan(/\/:(\w+)/).flatten.map(&:to_sym)
+      def required_variables
+        variables - optional_variables
+      end
+
+      def optional_variables
+        @pattern.scan(/\(\/?:(\w+)\)/).flatten.map(&:to_sym)
       end
   end
 end

data/lib/spyke/rfc_converter.rb

@@ -0,0 +1,28 @@
+module Spyke
+  class RfcConverter
+    def initialize(input)
+      @input = input
+    end
+
+    def convert
+      output = @input.dup
+      output = wrap_required_variables_in_curly_braces(output)
+      output = convert_parens_to_curly_braces(output)
+      output = remove_colons(output)
+      output
+    end
+
+    private
+      def wrap_required_variables_in_curly_braces(text)
+        text.gsub(/(:\w+(?!\)))\b/, '{\1}')
+      end
+
+      def convert_parens_to_curly_braces(text)
+        text.gsub('(', '{').gsub(')', '}')
+      end
+
+      def remove_colons(text)
+        text.gsub(':', '')
+      end
+  end
+end

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/spyke.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activemodel', '>= 4.0.0', '< 6.0'
   spec.add_dependency 'faraday', '>= 0.9.0', '< 2.0'
   spec.add_dependency 'faraday_middleware', '>= 0.9.1', '< 2.0'
-  spec.add_dependency 'uri_template', '>= 0.7.0', '< 2.0'
+  spec.add_dependency 'addressable', '>= 2.5.2'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'coveralls', '~> 0.7'

data/test/attributes_test.rb

@@ -92,7 +92,7 @@ module Spyke
 
     def test_explicit_attributes
       recipe = Recipe.new
-      assert_equal nil, recipe.title
+      assert_nil recipe.title
       assert_raises NoMethodError do
         recipe.not_set
       end
@@ -102,18 +102,18 @@ module Spyke
     end
 
     def test_super_with_explicit_attributes
-      assert_equal nil, Recipe.new.description
+      assert_nil Recipe.new.description
     end
 
     def test_inheriting_explicit_attributes
-      assert_equal nil, Image.new.description
-      assert_equal nil, Image.new.caption
+      assert_nil Image.new.description
+      assert_nil Image.new.caption
       assert_raises NoMethodError do
         Image.new.note
       end
-      assert_equal nil, StepImage.new.description
-      assert_equal nil, StepImage.new.caption
-      assert_equal nil, StepImage.new.note
+      assert_nil StepImage.new.description
+      assert_nil StepImage.new.caption
+      assert_nil StepImage.new.note
     end
 
     def test_converting_files_to_faraday_io

data/test/fallbacks_test.rb

@@ -24,7 +24,7 @@ module Spyke
     def test_find_one_with_default_fallback
       recipe = Recipe.with_fallback.where(id: 1).find_one
 
-      assert_equal nil, recipe
+      assert_nil recipe
     end
 
     def test_find_some_with_default_fallback

data/test/path_test.rb

@@ -20,16 +20,32 @@ module Spyke
       assert_equal '/users/1/recipes/2', Path.new('/users/:user_id/recipes/:id', user_id: 1, id: 2).to_s
     end
 
-    def test_required_params
-      assert_raises Spyke::InvalidPathError, 'Missing required params: user_id in /users/:user_id/recipes/(:id)' do
+    def test_required_variables
+      assert_raises Spyke::InvalidPathError, 'Missing required variables: user_id in /users/:user_id/recipes/(:id)' do
         Path.new('/users/:user_id/recipes/(:id)', id: 2).to_s
       end
     end
 
-    def test_optional_params_with_extension
-      skip 'wishlisted'
+    def test_mix_of_required_and_unrequired_variables
+      assert_raises Spyke::InvalidPathError, 'Missing required variables: part2, part4' do
+        Path.new('/1/profiles(/:part1)/:part2(/:part3)/:part4.xml').to_s
+      end
+    end
+
+    def test_present_optional_param_with_extension
       assert_equal '/1/profiles/2.json', Path.new('/1/profiles(/:id).json', id: 2).to_s
+    end
+
+    def test_missing_optional_variables_with_extension
       assert_equal '/1/profiles.json', Path.new('/1/profiles(/:id).json').to_s
     end
+
+    def test_multiple_missing_optional_variables_with_extension
+      assert_equal '/1/profiles.xml', Path.new('/1/profiles(/:id1)(/:id2)(/:id3)(/:id4).xml').to_s
+    end
+
+    def test_mixture_of_optional_variables_and_required_variables_with_extension
+      assert_equal '/1/profiles/other/2.xml', Path.new('/1/profiles(/:part1)/:part2(/:part3)/:id.xml', part2: 'other', id: 2).to_s
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-17 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -91,25 +91,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: uri_template
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.5.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -285,6 +279,7 @@ files:
 - lib/spyke/path.rb
 - lib/spyke/relation.rb
 - lib/spyke/result.rb
+- lib/spyke/rfc_converter.rb
 - lib/spyke/scope_registry.rb
 - lib/spyke/scoping.rb
 - lib/spyke/version.rb
@@ -320,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Interact with REST services in an ActiveRecord-like manner