spyke 1.0.0

data/test/attributes_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+module Spyke
+  class AttributesTest < MiniTest::Test
+    def test_predicate_methods
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sushi' })
+
+      recipe = Recipe.find(1)
+
+      assert_equal true, recipe.title?
+      assert_equal false, recipe.description?
+    end
+
+    def test_respond_to
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, serves: 3 })
+
+      recipe = Recipe.find(1)
+
+      assert_equal true, recipe.respond_to?(:serves)
+      assert_equal false, recipe.respond_to?(:story)
+    end
+
+    def test_assigning_attributes
+      recipe = Recipe.new(id: 2)
+      recipe.attributes = { title: 'Pasta' }
+
+      assert_equal 'Pasta', recipe.title
+      assert_equal 2, recipe.id
+    end
+
+    def test_removing_id_if_blank_string
+      recipe = Recipe.new
+
+      assert_nil recipe.id
+      assert_equal({ 'recipe' => {} }, recipe.to_params)
+
+      recipe.id = ''
+      assert_nil recipe.id
+      assert_equal({ 'recipe' => {} }, recipe.to_params)
+    end
+
+    def test_setters
+      recipe = Recipe.new
+      recipe.title = 'Sushi'
+      assert_equal 'Sushi', recipe.title
+    end
+
+    def test_equality
+      assert_equal Recipe.new(id: 2, title: 'Fish'), Recipe.new(id: 2, title: 'Fish')
+      refute_equal Recipe.new(id: 2, title: 'Fish'), Recipe.new(id: 1, title: 'Fish')
+      refute_equal Recipe.new(id: 2, title: 'Fish'), 'not_a_spyke_object'
+    end
+
+    def test_explicit_attributes
+      recipe = Recipe.new
+      assert_equal nil, recipe.title
+      assert_raises NoMethodError do
+        recipe.description
+      end
+
+      recipe = Recipe.new(title: 'Fish')
+      assert_equal 'Fish', recipe.title
+    end
+
+    def test_converting_files_to_faraday_io
+      Faraday::UploadIO.stubs(:new).with('/photo.jpg', 'image/jpeg').returns('UploadIO')
+      file = mock
+      file.stubs(:path).returns('/photo.jpg')
+      file.stubs(:content_type).returns('image/jpeg')
+
+      recipe = Recipe.new(image: Image.new(file: file))
+
+      assert_equal 'UploadIO', recipe.image.to_params['image']['file']
+      assert_equal 'UploadIO', recipe.to_params['recipe']['image']['file']
+
+      recipe = Recipe.new(image_attributes: { file: file })
+
+      assert_equal 'UploadIO', recipe.image.to_params['image']['file']
+      assert_equal 'UploadIO', recipe.to_params['recipe']['image']['file']
+    end
+
+    def test_inspect
+      recipe = Recipe.new(id: 2, title: 'Pizza', description: 'Delicious')
+      assert_equal '#<Recipe(/recipes/2) id: 2 title: "Pizza" description: "Delicious">', recipe.inspect
+    end
+
+    def test_rejecting_wrong_number_of_args
+      skip 'wishlisted'
+      stub_request(:any, /.*/)
+      recipe = Recipe.new(description: 'Delicious')
+      assert_raises ArgumentError do
+        recipe.description(2)
+      end
+      assert_raises ArgumentError do
+        recipe.description?(2)
+      end
+      assert_raises ArgumentError do
+        recipe.image(2)
+      end
+    end
+  end
+end

data/test/callbacks_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+module Spyke
+  class CallbacksTest < MiniTest::Test
+    def setup
+      stub_request(:any, /.*/)
+    end
+
+    def test_before_save
+      Recipe.any_instance.expects(:before_save_callback)
+      Recipe.create
+    end
+
+    def test_before_create
+      Recipe.any_instance.expects(:before_create_callback)
+      Recipe.create
+    end
+
+    def test_before_update
+      Recipe.any_instance.expects(:before_update_callback)
+      Recipe.new(id: 1).save
+    end
+  end
+end

data/test/custom_request_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+module Spyke
+  class CustomRequestTest < MiniTest::Test
+    def test_custom_get_request_from_class
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(data: [{ id: 1, title: 'Bread' }])
+      assert_equal %w{ Bread }, Recipe.get('/recipes/recent').map(&:title)
+      assert_requested endpoint
+    end
+
+    def test_get_request_with_prepended_scope
+      skip 'wishlisted'
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent?status=published')
+      Recipe.published.get('/recipes/recent')
+      assert_requested endpoint
+    end
+
+    def test_get_request_with_appended_scope
+      skip 'wishlisted'
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent?status=published')
+      Recipe.get('/recipes/recent').published.fetch
+      assert_requested endpoint
+    end
+
+    def test_custom_get_request_from_class
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/recent').to_return_json(data: [{ id: 1, title: 'Bread' }])
+      assert_equal %w{ Bread }, Recipe.get('/recipes/recent').map(&:title)
+      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')
+      assert_requested endpoint
+    end
+
+    def test_custom_put_request_from_instance
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/1/publish').to_return_json(data: { id: 1, status: 'published' })
+      recipe = Recipe.new(id: 1, status: 'unpublished')
+      recipe.put('/recipes/:id/publish')
+
+      assert_equal 'published', recipe.status
+      assert_requested endpoint
+    end
+
+    def test_custom_put_request_from_instance_with_symbol
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/1/draft')
+      recipe = Recipe.new(id: 1)
+      recipe.put(:draft)
+      assert_requested endpoint
+    end
+  end
+end

data/test/orm_test.rb

@@ -0,0 +1,136 @@
+require 'test_helper'
+
+module Spyke
+  class OrmTest < MiniTest::Test
+    def test_find
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sushi' })
+      stub_request(:get, 'http://sushi.com/users/1').to_return_json(data: { id: 1, name: 'Bob' })
+
+      recipe = Recipe.find(1)
+      user = User.find(1)
+
+      assert_equal 1, recipe.id
+      assert_equal 'Sushi', recipe.title
+      assert_equal 'Bob', user.name
+    end
+
+    def test_reload
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sushi' })
+
+      recipe = Recipe.find(1)
+      assert_equal 'Sushi', recipe.title
+
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1, title: 'Sashimi' })
+      recipe.reload
+      assert_equal 'Sashimi', recipe.title
+    end
+
+    def test_find_with_slug
+      endpoint = stub_request(:get, 'http://sushi.com/recipes/1').to_return_json(data: { id: 1 })
+      Recipe.find('1-delicious-soup')
+      assert_requested endpoint
+    end
+
+    def test_404
+      stub_request(:get, 'http://sushi.com/recipes/1').to_return(status: 404, body: { message: 'Not found' }.to_json)
+
+      assert_raises ResourceNotFound do
+        Recipe.find(1)
+      end
+    end
+
+    def test_save_new_record
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi' } }).to_return_json(data: { id: 1, title: 'Sushi (created)' })
+
+      recipe = Recipe.new(title: 'Sushi')
+      recipe.save
+
+      assert_equal 'Sushi (created)', recipe.title
+      assert_requested endpoint
+    end
+
+    def test_save_persisted_record
+      stub_request(:put, /.*/)
+      endpoint = stub_request(:put, 'http://sushi.com/recipes/1').with(body: { recipe: { title: 'Sushi' } }).to_return_json(data: { id: 1, title: 'Sushi (saved)' })
+
+      recipe = Recipe.new(id: 1, title: 'Sashimi')
+      recipe.title = 'Sushi'
+      recipe.save
+
+      assert_equal 'Sushi (saved)', recipe.title
+      assert_requested endpoint
+    end
+
+    def test_create
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi' } }).to_return_json(data: { id: 1, title: 'Sushi' })
+
+      recipe = Recipe.create(title: 'Sushi')
+
+      assert_equal 'Sushi', recipe.title
+      assert_requested endpoint
+    end
+
+    def test_find_using_custom_uri_template
+      endpoint = stub_request(:get, 'http://sushi.com/images/photos/1').to_return_json(data: { id: 1 })
+      Photo.find(1)
+      assert_requested endpoint
+    end
+
+    def test_create_using_custom_uri_template
+      endpoint = stub_request(:post, 'http://sushi.com/images/photos')
+      Photo.create
+      assert_requested endpoint
+    end
+
+    def test_create_using_nested_custom_uri_template
+      endpoint = stub_request(:post, 'http://sushi.com/recipes/1/ingredients')
+      Ingredient.new(recipe_id: 1).save
+      assert_requested endpoint
+    end
+
+    def test_create_using_custom_method
+      endpoint = stub_request(:put, 'http://sushi.com/images')
+      Image.create
+      assert_requested endpoint
+    end
+
+    def test_inheritance_using_custom_method
+      endpoint = stub_request(:put, 'http://sushi.com/step_images')
+      StepImage.create
+      assert_requested endpoint
+    end
+
+    def test_non_nested_params
+      assert_equal({ 'url' => 'bob.jpg' }, RecipeImage.new(url: 'bob.jpg').to_params)
+    end
+
+    def test_destroy
+      endpoint = stub_request(:delete, 'http://sushi.com/recipes/1')
+      Recipe.new(id: 1).destroy
+      assert_requested endpoint
+    end
+
+    def test_destroy_class_method
+      endpoint = stub_request(:delete, 'http://sushi.com/recipes/1')
+      Recipe.destroy(1)
+      assert_requested endpoint
+    end
+
+    def test_scoped_destroy_class_method
+      endpoint = stub_request(:delete, 'http://sushi.com/recipes/1/ingredients/2')
+      Ingredient.where(recipe_id: 1).destroy(2)
+      assert_requested endpoint
+    end
+
+    def test_scoped_destroy_class_method_without_param
+      endpoint = stub_request(:delete, 'http://sushi.com/recipes/1/image')
+      RecipeImage.where(recipe_id: 1).destroy
+      assert_requested endpoint
+    end
+
+    def test_validations
+      assert_equal false, RecipeImage.new.valid?
+      assert_equal true, RecipeImage.new(url: 'bob.jpg').valid?
+    end
+  end
+end

data/test/path_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+module Spyke
+  class PathTest < MiniTest::Test
+    def test_collection_path
+      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
+    end
+
+    def test_nested_collection_path
+      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
+
+    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
+  end
+end

data/test/relation_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+module Spyke
+  class RelationTest < MiniTest::Test
+    def test_all
+      stub_request(:get, 'http://sushi.com/recipes').to_return_json(data: [{ id: 1, title: 'Sushi' }, { id: 2, title: 'Nigiri' }], metadata: 'meta')
+
+      recipes = Recipe.all
+
+      assert_equal %w{ Sushi Nigiri }, recipes.map(&:title)
+      assert_equal [1, 2], recipes.map(&:id)
+      assert_equal 'meta', recipes.metadata
+    end
+
+    def test_chainable_where
+      endpoint = stub_request(:get, 'http://sushi.com/recipes?status=published&per_page=3')
+
+      Recipe.where(status: 'published').where(per_page: 3).to_a
+
+      assert_requested endpoint
+    end
+
+    def test_chainable_class_method
+      endpoint = stub_request(:get, 'http://sushi.com/recipes?status=published&per_page=3')
+
+      Recipe.where(per_page: 3).published.to_a
+
+      assert_requested endpoint
+    end
+
+    def test_prepended_chainable_class_method
+      endpoint = stub_request(:get, 'http://sushi.com/recipes?status=published&per_page=3')
+
+      Recipe.published.where(per_page: 3).to_a
+
+      assert_requested endpoint
+    end
+
+    def test_scope_class_method
+      endpoint = stub_request(:get, 'http://sushi.com/recipes?status=published&page=3')
+
+      Recipe.published.page(3).to_a
+      assert_requested endpoint
+    end
+
+    def test_scope_doesnt_get_stuck
+      endpoint_1 = stub_request(:get, 'http://sushi.com/recipes?per_page=3&status=published')
+      endpoint_2 = stub_request(:get, 'http://sushi.com/recipes?status=published')
+
+      Recipe.where(status: 'published').where(per_page: 3).to_a
+      Recipe.where(status: 'published').to_a
+      assert_requested endpoint_1
+      assert_requested endpoint_2
+    end
+
+    def test_create_scoped
+      endpoint = stub_request(:post, 'http://sushi.com/recipes').with(body: { recipe: { title: 'Sushi', status: 'published' } })
+
+      Recipe.published.create(title: 'Sushi')
+
+      assert_requested endpoint
+    end
+
+    def test_cached_result
+      endpoint_1 = stub_request(:get, 'http://sushi.com/recipes?status=published&per_page=3')
+      endpoint_2 = stub_request(:get, 'http://sushi.com/recipes?status=published')
+
+      recipes = Recipe.published.where(per_page: 3)
+      recipes.any?
+      recipes.to_a
+      assert_requested endpoint_1, times: 1
+      Recipe.published.to_a
+      assert_requested endpoint_2, times: 1
+    end
+  end
+end

data/test/support/api.rb

@@ -0,0 +1,6 @@
+# Set up dummy api
+Spyke::Config.connection = Faraday.new(url: 'http://sushi.com') do |faraday|
+  faraday.request   :json
+  faraday.response  :json
+  faraday.adapter   Faraday.default_adapter
+end

data/test/support/fixtures.rb

@@ -0,0 +1,65 @@
+class Recipe < Spyke::Base
+  has_many :groups
+  has_one :image
+  has_one :background_image, class_name: 'Image', uri: nil
+  has_one :alternate, class_name: 'Recipe', uri: '/recipes/:recipe_id/alternates/recipe'
+  belongs_to :user
+
+  scope :published, -> { where(status: 'published') }
+  attributes :title
+
+  before_save :before_save_callback
+  before_create :before_create_callback
+  before_update :before_update_callback
+
+  accepts_nested_attributes_for :image, :user, :groups
+
+  def self.page(number)
+    if number.present?
+      where(page: number)
+    else
+      all
+    end
+  end
+
+  def ingredients
+    groups.first.ingredients
+  end
+
+  private
+
+    def before_create_callback; end
+    def before_update_callback; end
+    def before_save_callback; end
+end
+
+class Image < Spyke::Base
+  method_for :create, :put
+end
+
+class StepImage < Image
+end
+
+class RecipeImage < Image
+  uri '/recipes/:recipe_id/image'
+  validates :url, presence: true
+  attributes :url
+  include_root_in_json false
+end
+
+class Group < Spyke::Base
+  has_many :ingredients, uri: nil
+  accepts_nested_attributes_for :ingredients
+end
+
+class Ingredient < Spyke::Base
+  uri '/recipes/:recipe_id/ingredients/:id'
+end
+
+class User < Spyke::Base
+  has_many :recipes
+end
+
+class Photo < Spyke::Base
+  uri '/images/photos/:id'
+end