spyke 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8c05691c5a62ac3b717844d0c3f87890ab7c902
-  data.tar.gz: 7edc244c8975b0ec3c5f1887e53866fafb8dde04
+  metadata.gz: b1e4e0a09a6e130d78cdfc11ad4c46baee78c332
+  data.tar.gz: ef161ce8bdf5013e36e41e5054ac461d58c84b88
 SHA512:
-  metadata.gz: 05a0f43e35a3411bfab96a7825ad75a9721d3177fc90d1c6b26a29c9d68e43e5476448c14bbba8972ac4d7458efd64a89a04acac929340551d0378f64717b5cb
-  data.tar.gz: e1a53e75a003f0a7dba3c0ecf5151a7b40477b97ab5cc85ddce8e1535ca875ba79c00a04ab679dd3d1904d70049ddf29163a9c2cac6c22ddbd6fffd21ca8a991
+  metadata.gz: bf368cf28410559c6fdc38f3f14c24b28effe957d05249aced614adfcbcb39869dc6092c329c46c1bc79ce30200167e481db4c1a1925005c21d6072596d5a3e5
+  data.tar.gz: be1d98fa2a3fab4ef8e19cee15d179a4a937a8108bfe5f789a6406aa9e2c9652bd754e256eb25ecbbb59dea79d40585a3d29351d505e335a65eb14d04e2d6c2a

data/README.md

@@ -58,7 +58,7 @@ end
 Spyke::Config.connection = Faraday.new(url: 'http://api.com') do |c|
   c.request   :json
   c.use       JSONParser
-  c.use       Faraday.default_adapter
+  c.adapter   Faraday.default_adapter
 end
 ```
 
@@ -104,10 +104,10 @@ You can specify custom URIs on both the class and association level:
 
 ```ruby
 class User < Spyke::Base
-  uri '/v1/users/:id'
+  uri '/v1/users/(:id)' # id optional, both /v1/users and /v1/users/4 are usable
 
   has_one :image, uri: nil
-  has_many :posts, uri: '/posts/for_user/:user_id'
+  has_many :posts, uri: '/posts/for_user/:user_id' # user_id is required
 end
 
 class Post < Spyke::Base

data/lib/spyke/associations/has_many.rb

@@ -3,7 +3,7 @@ module Spyke
     class HasMany < Association
       def initialize(*args)
         super
-        @options.reverse_merge!(uri: "/#{parent.class.model_name.plural}/:#{foreign_key}/#{klass.model_name.plural}/:id")
+        @options.reverse_merge!(uri: "/#{parent.class.model_name.plural}/:#{foreign_key}/#{klass.model_name.plural}/(:id)")
         @params[foreign_key] = parent.id
       end
 

data/lib/spyke/http.rb

@@ -50,7 +50,7 @@ module Spyke
         Collection.new Array(result.data).map { |record| new(record) }, result.metadata
       end
 
-      def uri(uri_template = "/#{model_name.plural}/:id")
+      def uri(uri_template = "/#{model_name.plural}/(:id)")
         @uri ||= uri_template
       end
 

data/lib/spyke/path.rb

@@ -1,10 +1,12 @@
 require 'uri_template'
 
 module Spyke
+  class InvalidPathError < StandardError; end
   class Path
-    def initialize(uri_template, params = {})
-      @uri_template = URITemplate.new(:colon, uri_template)
-      @params = params
+
+    def initialize(pattern, params = {})
+      @pattern = pattern
+      @params = params.symbolize_keys
     end
 
     def join(other_path)
@@ -16,13 +18,36 @@ module Spyke
     end
 
     def variables
-      @variables ||= @uri_template.variables.map(&:to_sym)
+      @variables ||= uri_template.variables.map(&:to_sym)
     end
 
     private
 
+      def uri_template
+        @uri_template ||= URITemplate.new(:colon, pattern_with_rfc_style_parens)
+      end
+
+      def pattern_with_rfc_style_parens
+        @pattern.gsub('(', '{').gsub(')', '}')
+      end
+
       def path
-        @uri_template.expand(@params).chomp('/')
+        validate_required_params!
+        uri_template.expand(@params).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)"
+        end
+      end
+
+      def missing_required_params
+        required_params - @params.keys
+      end
+
+      def required_params
+        @pattern.scan(/\/:(\w+)/).flatten.map(&:to_sym)
       end
   end
 end

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/test/path_test.rb

@@ -3,15 +3,15 @@ require 'test_helper'
 module Spyke
   class PathTest < MiniTest::Test
     def test_collection_path
-      assert_equal '/recipes', Path.new('/recipes/:id').to_s
+      assert_equal '/recipes', Path.new('/recipes/(:id)').to_s
     end
 
     def test_resource_path
-      assert_equal '/recipes/2', Path.new('/recipes/:id', id: 2).to_s
+      assert_equal '/recipes/2', Path.new('/recipes/(:id)', id: 2).to_s
     end
 
     def test_nested_collection_path
-      path = Path.new('/users/:user_id/recipes/:id', user_id: 1, status: 'published')
+      path = Path.new('/users/:user_id/recipes/(:id)', user_id: 1, status: 'published')
       assert_equal [:user_id, :id], path.variables
       assert_equal '/users/1/recipes', path.to_s
     end
@@ -19,5 +19,11 @@ module Spyke
     def test_nested_resource_path
       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
+        Path.new('/users/:user_id/recipes/(:id)', id: 2).to_s
+      end
+    end
   end
 end

data/test/relation_test.rb

@@ -116,5 +116,13 @@ module Spyke
       Recipe.published.to_a
       assert_requested endpoint_2, times: 1
     end
+
+    def test_namespaced_model
+      tip_endpoint = stub_request(:get, 'http://sushi.com/tips/1').to_return_json(result: { id: 1 })
+      likes_endpoint = stub_request(:get, 'http://sushi.com/tips/1/likes')
+      Cookbook::Tip.find(1).likes.first
+      assert_requested tip_endpoint
+      assert_requested likes_endpoint
+    end
   end
 end

data/test/support/fixtures.rb

@@ -59,7 +59,7 @@ class Group < Spyke::Base
 end
 
 class Ingredient < Spyke::Base
-  uri '/recipes/:recipe_id/ingredients/:id'
+  uri '/recipes/:recipe_id/ingredients/(:id)'
 end
 
 class User < Spyke::Base
@@ -67,7 +67,7 @@ class User < Spyke::Base
 end
 
 class Photo < Spyke::Base
-  uri '/images/photos/:id'
+  uri '/images/photos/(:id)'
 end
 
 class Comment < Spyke::Base
@@ -87,3 +87,13 @@ class Search
     recipes.metadata[:suggestions]
   end
 end
+
+module Cookbook
+  class Tip < Spyke::Base
+    uri '/tips/(:id)'
+    has_many :likes, class_name: 'Cookbook::Like', uri: '/tips/:cookbook_tip_id/likes/(:id)'
+  end
+
+  class Like < Spyke::Base
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport