spyke 1.8.11 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c05f29726a60edf95e40f701f6e1c25b362eb56
-  data.tar.gz: 373739290398204bd2954fe21b623fd5812af70c
+  metadata.gz: debb215522b638dd3b33070246527635aabfc284
+  data.tar.gz: 5e02ddc322d6a4811229cf939616eb5227e0d90c
 SHA512:
-  metadata.gz: deab62cb350a993a9a563a6a92594238048f1a9e908d6767e4fb4b95e8e15cb9b41a71316c058186a0622de767c99cdb3cb7057c957ecde28da62d6bb3b71750
-  data.tar.gz: 19f8ec5668c71e2c588a28da72e87fdaa1e64346018998aac3be60217746752813e2dec35c43c03ca9a7dfa1a9c60ed7dacd92996d5648d28d4da49a011c1853
+  metadata.gz: 123c24f04e9f34ed7f0f3a3335c94573266f39171d9c2183d1125d7235ed239a44766e6cf9771bcd6ca40e41ac8411756551777b215b27438def9ee1be233d44
+  data.tar.gz: ebf9567257ae4c3b2ec20c7a837b667f2107f1877d3c18471ec886779b25916f7de0617ca37919a6a3da7c5384b29ec46ad6808a1b1d1ef8c74ec7d6d4ad2cff

data/README.md

@@ -58,12 +58,10 @@ class JSONParser < Faraday::Response::Middleware
       metadata: json[:extra],
       errors: json[:errors]
     }
-  rescue MultiJson::ParseError => exception
-    { errors: { base: [ error: exception.message ] } }
   end
 end
 
-Spyke::Config.connection = Faraday.new(url: 'http://api.com') do |c|
+Spyke::Base.connection = Faraday.new(url: 'http://api.com') do |c|
   c.request   :json
   c.use       JSONParser
   c.adapter   Faraday.default_adapter
@@ -77,7 +75,6 @@ Adding a class and inheriting from `Spyke::Base` will allow you to interact with
 ```ruby
 class User < Spyke::Base
   has_many :posts
-
   scope :active, -> { where(active: true) }
 end
 
@@ -108,7 +105,9 @@ User.create(name: 'Bob')
 
 ### Custom URIs
 
-You can specify custom URIs on both the class and association level:
+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.
 
 ```ruby
 class User < Spyke::Base
@@ -127,23 +126,37 @@ user.posts # => GET http://api.com/posts/for_user/3
 Post.find(4) # => GET http://api.com/posts/4
 ```
 
-### Log output
+### Custom requests
 
-When used with Rails, Spyke will automatically output helpful
-ActiveRecord-like messages to the main log:
+Custom request methods and the `using` scope methods allow you to
+perform requests for non-REST actions:
 
-```bash
-Started GET "/posts" for 127.0.0.1 at 2014-12-01 14:31:20 +0000
-Processing by PostsController#index as HTML
-  Parameters: {}
-  Spyke (40.3ms)  GET http://api.com/posts [200]
-Completed 200 OK in 75ms (Views: 64.6ms | Spyke: 40.3ms | ActiveRecord: 0ms)
+The `.using` scope:
+
+```ruby
+Post.using('posts/recent') # => GET http://api.com/posts/recent
+Post.using(:recent) # => GET http://api.com/posts/recent
+Post.using(:recent).where(status: 'draft') # => GET http://api.com/posts/recent?status=draft
+Post.using(:recent).post # => POST http://api.com/posts/recent
+```
+
+Custom requests from instance:
+
+```ruby
+Post.find(3).put(:publish) # => PUT http://api.com/posts/3/publish
+```
+
+Arbitrary requests (returns plain Result object):
+
+```ruby
+Post.request(:post, 'posts/3/log', time: '12:00')
+# => POST http://api.com/posts/3/log - { time: '12:00' }
 ```
 
 ### API-side validations
 
 Spyke expects errors to be formatted in the same way as the
-ActiveModel::Errors hash, ie:
+[ActiveModel::Errors details hash](https://cowbell-labs.com/2015-01-22-active-model-errors-details.html), ie:
 
 ```ruby
 { title: [{ error: 'blank'}, { error: 'too_short', count: 10 }]}
@@ -154,7 +167,39 @@ remap it in Faraday to match the above. Doing this will allow you to
 show errors returned from the server in forms and f.ex using
 `@post.errors.full_messages` just like ActiveRecord.
 
+### Using multiple APIs
+
+If you need to use different APIs, instead of configuring `Spyke::Base`
+you can configure each class individually:
+
+```ruby
+class Post < Spyke::Base
+  self.connection = Faraday.new(url: 'http://sashimi.com') do |faraday|
+    # middleware
+  end
+end
+```
+
+### Log output
+
+When used with Rails, Spyke will automatically output helpful
+ActiveRecord-like messages to the main log:
+
+```bash
+Started GET "/posts" for 127.0.0.1 at 2014-12-01 14:31:20 +0000
+Processing by PostsController#index as HTML
+  Parameters: {}
+  Spyke (40.3ms)  GET http://api.com/posts [200]
+Completed 200 OK in 75ms (Views: 64.6ms | Spyke: 40.3ms | ActiveRecord: 0ms)
+```
+
+### Other examples
+
+For more examples of how Spyke can be used, check out [fixtures.rb](https://github.com/balvig/spyke/blob/master/test/support/fixtures.rb) and the
+[test suite](https://github.com/balvig/spyke/tree/master/test).
+
+
 ## Contributing
 
 If possible please take a look at the [tests marked "wishlisted"](https://github.com/balvig/spyke/search?l=ruby&q=wishlisted&utf8=%E2%9C%93)!
-These are features/fixes we want to implement but haven't gotten around to doing yet :)
+These are features/fixes I'd like to implement but haven't gotten around to doing yet :)

data/lib/spyke/config.rb

@@ -1,5 +1,8 @@
 module Spyke
   class Config
-    class_attribute :connection
+    def self.connection=(faraday)
+      warn "[DEPRECATION] `Spyke::Config.connection=` is deprecated.  Please use `Spyke::Base.connection=` instead."
+      Spyke::Base.connection = faraday
+    end
   end
 end

data/lib/spyke/http.rb

@@ -9,14 +9,29 @@ module Spyke
     extend ActiveSupport::Concern
     METHODS = %i{ get post put patch delete }
 
+    included do
+      class_attribute :connection, instance_accessor: false
+    end
+
     module ClassMethods
       METHODS.each do |method|
-        define_method(method) do |path, params = {}|
-          new_instance_or_collection_from_result send("#{method}_raw", path, params)
+        define_method(method) do
+          new_instance_or_collection_from_result scoped_request(method)
         end
+      end
 
-        define_method("#{method}_raw") do |path, params = {}|
-          request(method, path, params)
+      def request(method, path, params = {})
+        ActiveSupport::Notifications.instrument('request.spyke', method: method) do |payload|
+          response = connection.send(method) do |request|
+            if method == :get
+              request.url path.to_s, params
+            else
+              request.url path.to_s
+              request.body = params
+            end
+          end
+          payload[:url], payload[:status] = response.env.url, response.status
+          Result.new_from_response(response)
         end
       end
 
@@ -29,28 +44,15 @@ module Spyke
       end
 
       def uri(uri_template = nil)
-        @uri ||= uri_template || superclass_uri || default_uri
-      end
-
-      def connection
-        Config.connection
+        @uri ||= uri_template || default_uri
       end
 
       private
 
-        def request(method, path, params = {})
-          ActiveSupport::Notifications.instrument('request.spyke', method: method) do |payload|
-            response = connection.send(method) do |request|
-              if method == :get
-                request.url path.to_s, params
-              else
-                request.url path.to_s
-                request.body = params
-              end
-            end
-            payload[:url], payload[:status] = response.env.url, response.status
-            Result.new_from_response(response)
-          end
+        def scoped_request(method)
+          uri = new.uri
+          params = current_scope.params.except(*uri.variables)
+          request(method, uri, params)
         end
 
         def new_instance_or_collection_from_result(result)
@@ -69,10 +71,6 @@ module Spyke
           end
         end
 
-        def superclass_uri
-          superclass.uri.dup.freeze if superclass != Base
-        end
-
         def default_uri
           "#{model_name.plural}/(:id)"
         end
@@ -83,7 +81,7 @@ module Spyke
         params = action if action.is_a?(Hash)
         path = resolve_path_from_action(action)
 
-        result = self.class.send("#{method}_raw", path, params)
+        result = self.class.request(method, path, params)
 
         add_errors_to_model(result.errors)
         self.attributes = result.data

data/lib/spyke/orm.rb

@@ -8,7 +8,7 @@ module Spyke
       class_attribute :include_root
       self.include_root = true
 
-      class_attribute :callback_methods
+      class_attribute :callback_methods, instance_accessor: false
       self.callback_methods = { create: :post, update: :put }.freeze
     end
 
@@ -29,8 +29,7 @@ module Spyke
       end
 
       def fetch
-        uri = new.uri
-        get_raw uri, current_scope.params.except(*uri.variables)
+        scoped_request :get
       end
 
       def create(attributes = {})

data/lib/spyke/relation.rb

@@ -18,6 +18,15 @@ module Spyke
       relation
     end
 
+    def using(uri)
+      if uri.is_a? Symbol
+        @options[:uri] = File.join @options[:uri], uri.to_s
+      else
+        @options[:uri] = uri
+      end
+      where
+    end
+
     # Overrides Enumerable find
     def find(id)
       scoping { klass.find(id) }

data/lib/spyke/scoping.rb

@@ -7,6 +7,7 @@ module Spyke
 
     module ClassMethods
       delegate :where, :build, :any?, :empty?, to: :all
+      delegate :using, to: :all
 
       def all
         current_scope || Relation.new(self, uri: uri)

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '1.8.11'
+  VERSION = '2.0.0'
 end

data/test/attributes_test.rb

@@ -2,7 +2,6 @@ require 'test_helper'
 
 module Spyke
   class AttributesTest < MiniTest::Test
-
     def test_block_initialization
       recipe = Recipe.new do |r|
         r.title = 'Sushi'

data/test/callbacks_test.rb

@@ -6,17 +6,18 @@ module Spyke
       stub_request(:any, /.*/)
     end
 
-    def test_before_save
-      Recipe.any_instance.expects(:before_save_callback)
+    def test_before_create
+      Recipe.any_instance.expects(:before_create_callback)
       Recipe.create
     end
 
-    def test_before_create
-      Recipe.any_instance.expects(:before_create_callback)
+    def test_before_save
+      Recipe.any_instance.expects(:before_save_callback)
       Recipe.create
     end
 
     def test_before_update
+      Recipe.any_instance.expects(:before_save_callback)
       Recipe.any_instance.expects(:before_update_callback)
       Recipe.new(id: 1).save
     end

data/test/custom_request_test.rb

@@ -2,36 +2,40 @@ require 'test_helper'
 
 module Spyke
   class CustomRequestTest < MiniTest::Test
-    def test_custom_get_request_using_class_method
+    def test_custom_get_request_from_class
       endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(result: [{ id: 1, title: 'Bread' }])
-      recipes = Recipe.get('/recipes/recent')
+      recipes = Recipe.using('/recipes/recent').get
       assert_equal %w{ Bread }, recipes.map(&:title)
       assert_requested endpoint
     end
 
-    def test_get_request_with_prepended_scope
-      skip 'wishlisted'
+    def test_custom_put_request_from_class
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/publish_all')
+      Recipe.using('/recipes/publish_all').put
+      assert_requested endpoint
+    end
+
+    def test_custom_request_with_prepended_scope
       endpoint = stub_request(:get, 'http://sushi.com/recipes/recent?status=published')
-      Recipe.published.get('/recipes/recent')
+      Recipe.published.using('/recipes/recent').to_a
       assert_requested endpoint
     end
 
-    def test_get_request_with_appended_scope
-      skip 'wishlisted'
+    def test_custom_request_with_appended_scope
       endpoint = stub_request(:get, 'http://sushi.com/recipes/recent?status=published')
-      Recipe.get('/recipes/recent').published.to_a
+      Recipe.using('/recipes/recent').published.to_a
       assert_requested endpoint
     end
 
-    def test_custom_get_request_from_class
-      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(result: [{ id: 1, title: 'Bread' }])
-      assert_equal %w{ Bread }, Recipe.get('/recipes/recent').map(&:title)
+    def test_custom_request_with_symbol_and_appended_scope
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent?status=published')
+      Recipe.using(:recent).published.to_a
       assert_requested endpoint
     end
 
-    def test_custom_put_request_from_class
-      endpoint = stub_request(:put, 'http://sushi.com/recipes/1/publish')
-      Recipe.put('/recipes/1/publish')
+    def test_create_on_custom_request
+      endpoint = stub_request(:post, 'http://sushi.com/recipes/recent').with(body: { recipe: { status: 'published' } })
+      Recipe.using(:recent).published.create
       assert_requested endpoint
     end
 
@@ -50,5 +54,11 @@ module Spyke
       recipe.put(:draft)
       assert_requested endpoint
     end
+
+    def test_multiple_apis
+      endpoint = stub_request(:get, 'http://sashimi.com/other_recipes')
+      OtherRecipe.all.to_a
+      assert_requested endpoint
+    end
   end
 end

data/test/orm_test.rb

@@ -113,12 +113,6 @@ module Spyke
       assert_requested endpoint
     end
 
-    def test_inheritance_passes_on_custom_method_and_uri
-      endpoint = stub_request(:put, 'http://sushi.com/images')
-      StepImage.create
-      assert_requested endpoint
-    end
-
     def test_inheritance_not_overwriting_custom_uri
       endpoint = stub_request(:put, 'http://sushi.com/recipes/1/image')
       RecipeImage.where(recipe_id: 1).create
@@ -158,14 +152,14 @@ module Spyke
     end
 
     def test_relative_uris
-      previous = Spyke::Config.connection.url_prefix
-      Spyke::Config.connection.url_prefix = 'http://sushi.com/api/v2/'
+      previous = Spyke::Base.connection.url_prefix
+      Spyke::Base.connection.url_prefix = 'http://sushi.com/api/v2/'
 
       endpoint = stub_request(:get, 'http://sushi.com/api/v2/recipes')
       Recipe.all.to_a
       assert_requested endpoint
 
-      Spyke::Config.connection.url_prefix = previous
+      Spyke::Base.connection.url_prefix = previous
     end
   end
 end

data/test/support/fixtures.rb

@@ -1,3 +1,24 @@
+# Dummy api
+class JSONParser < Faraday::Response::Middleware
+  def parse(body)
+    json = MultiJson.load(body, symbolize_keys: true)
+    {
+      data: json[:result],
+      metadata: json[:metadata],
+      errors: json[:errors]
+    }
+  rescue MultiJson::ParseError => exception
+    { errors: { base: [ error: exception.message ] } }
+  end
+end
+
+Spyke::Base.connection = Faraday.new(url: 'http://sushi.com') do |faraday|
+  faraday.request   :json
+  faraday.use       JSONParser
+  faraday.adapter   Faraday.default_adapter
+end
+
+# Test classes
 class Recipe < Spyke::Base
   has_many :groups
   has_many :gallery_images, class_name: 'Image'
@@ -83,6 +104,15 @@ class Comment < Spyke::Base
   scope :approved, -> { where(comment_approved: true) }
 end
 
+class OtherApi < Spyke::Base
+  self.connection = Faraday.new(url: 'http://sashimi.com') do |faraday|
+    faraday.use       JSONParser
+    faraday.adapter   Faraday.default_adapter
+  end
+end
+
+class OtherRecipe < OtherApi; end
+
 class Search
   def initialize(query)
     @query = query

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 1.8.11
+  version: 2.0.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -296,7 +296,6 @@ files:
 - test/orm_test.rb
 - test/path_test.rb
 - test/relation_test.rb
-- test/support/api.rb
 - test/support/fixtures.rb
 - test/support/webmock.rb
 - test/test_helper.rb
@@ -332,7 +331,6 @@ test_files:
 - test/orm_test.rb
 - test/path_test.rb
 - test/relation_test.rb
-- test/support/api.rb
 - test/support/fixtures.rb
 - test/support/webmock.rb
 - test/test_helper.rb

data/test/support/api.rb

@@ -1,19 +0,0 @@
-# Set up dummy api
-class JSONParser < Faraday::Response::Middleware
-  def parse(body)
-    json = MultiJson.load(body, symbolize_keys: true)
-    {
-      data: json[:result],
-      metadata: json[:metadata],
-      errors: json[:errors]
-    }
-  rescue MultiJson::ParseError => exception
-    { errors: { base: [ error: exception.message ] } }
-  end
-end
-
-Spyke::Config.connection = Faraday.new(url: 'http://sushi.com') do |faraday|
-  faraday.request   :json
-  faraday.use       JSONParser
-  faraday.adapter   Faraday.default_adapter
-end