jeckle 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc145a2c57d49e16a1eb949572d0e5d5b332e84c
-  data.tar.gz: d9777c608e3647a7a4280c9d2b6a9c7accb0156e
+  metadata.gz: 0fedf58b9859236e613f70bb3cfaf8f34fcba6cd
+  data.tar.gz: f5671e5ec06652de45455208795669c487decaa8
 SHA512:
-  metadata.gz: 0ce7714c1ba50c9feafa7327766f9eb8d8e5d515c02e9928519eeb6f9b8f7f60e272d68bc0b7ef6080a31218c1a3b4f94f647fa04b7d4c53d8d270c1160dc4c7
-  data.tar.gz: d5aa1c13218e74e196d08b9236e2f2b5c35a232aca955c8d0aabcba610adc823722f33fc240b8f1b4dc5fabc42989f2ff23d79ac66b9c2989a15904c8d959824
+  metadata.gz: d052c4ef86214fcd06f9f84c9f959e02c5c83c2d3560652f8d0fb5206f3a090f8b09d8662cd500bb125206f20cd3d7f44d2dcf33a464bfdbac66b7f99ef6d0a1
+  data.tar.gz: 58f383cc88ac992dbef23a98e2c5af620d0c14fdf774373f8a8aa9f07a0b0f722ee496caa03769fd4324c6e7b3e060c0f65bb12f0e424e8ddb56b18da4a86ffc

data/History.markdown

@@ -0,0 +1,11 @@
+## v.0.3.0
+
+* Change Jeckle::Resource.default_api to Jeckle::Resource.api
+
+## v.0.2.1
+
+* Fix bug when APIs includes root in json responses
+
+## v.0.2.0
+
+* Add Jeckle middlewares

data/README.md

@@ -56,7 +56,7 @@ module SomeService
     class MyResource
       include Jeckle::Resource
 
-      default_api :some_service
+      api :some_service
 
       attribute :id
     end

data/examples/dribbble.rb

@@ -9,7 +9,7 @@ end
 class Shot
   include Jeckle::Resource
 
-  default_api :dribbble
+  api :dribbble
 
   attribute :id, Integer
   attribute :name, String

data/lib/jeckle/http.rb

@@ -0,0 +1,79 @@
+module Jeckle
+  module HTTP
+    def self.included(base)
+      base.extend Jeckle::HTTP::APIMapping
+    end
+
+    module APIMapping
+      def inherited(base)
+        base.class_eval do
+          @api_mapping = superclass.api_mapping.dup
+        end
+      end
+
+      # The name of the resource that Jeckle uses to make the request
+      #
+      # @example
+      #
+      #   module Dribble
+      #     class Shot
+      #       include Jeckle::Resource
+      #     end
+      #   end
+      #
+      #   Shot.resource_name # => Will request for '/shots' resource
+      #
+      # To overwrite this behaviour, rewrite the resource name method in the class:
+      #
+      #   module OtherApi
+      #     class Project
+      #       include Jeckle::Resource
+      #
+      #       def self.resource_name
+      #         '/project'
+      #       end
+      #     end
+      #   end
+      #
+      def resource_name
+        @resource_name ||= model_name.element.pluralize
+      end
+
+      # The API name that Jeckle uses to find all the api settings like domain, headers, etc.
+      #
+      # @example
+      #
+      #   Jeckle.configure do |config|
+      #     config.register :dribbble do |api|
+      #       api.base_uri = 'http://api.dribbble.com'
+      #     end
+      #   end
+      #
+      #   class Shot
+      #     include Jeckle::Resource
+      #     api :dribbble
+      #   end
+      #
+      def api(registered_api_name)
+        api_mapping[:default_api] = Jeckle::Setup.registered_apis.fetch(registered_api_name)
+      rescue KeyError => e
+        raise Jeckle::NoSuchAPIError, registered_api_name
+      end
+
+      # @deprecated Please use {#api} instead
+      #
+      def default_api(registered_api_name)
+        warn "[DEPRECATION] `default_api` is deprecated.  Please use `api` instead."
+        api(registered_api_name)
+      end
+
+      def api_mapping
+        @api_mapping ||= {}
+      end
+
+      def run_request(endpoint, options = {})
+        Jeckle::Request.run api_mapping[:default_api], endpoint, options
+      end
+    end
+  end
+end

data/lib/jeckle/request.rb

@@ -5,8 +5,8 @@ module Jeckle
     def initialize(api, endpoint, options = {})
       @api = api
 
-      @method = options.delete(:method) || :get
-      @body = options.delete(:body) if %w(post put).include?(method.to_s)
+      @method  = options.delete(:method) || :get
+      @body    = options.delete(:body) if %w(post put).include?(method.to_s)
       @headers = options.delete(:headers)
 
       @endpoint = endpoint
@@ -24,8 +24,8 @@ module Jeckle
     def perform_api_request
       api.connection.public_send method do |api_request|
         api_request.url endpoint
-        api_request.params = params
-        api_request.body = body
+        api_request.params  = params
+        api_request.body    = body
         api_request.headers = api_request.headers.merge(headers) if headers
       end
     end

data/lib/jeckle/resource.rb

@@ -1,50 +1,11 @@
 module Jeckle
   module Resource
     def self.included(base)
-      base.send :include, Jeckle::Model
       base.send :include, ActiveModel::Naming
 
-      base.send :extend, Jeckle::Resource::ClassMethods
-    end
-
-    module ClassMethods
-      def inherited(base)
-        base.class_eval do
-          @api_mapping = superclass.api_mapping.dup
-        end
-      end
-
-      def resource_name
-        model_name.element.pluralize
-      end
-
-      def default_api(registered_api_name)
-        api_mapping[:default_api] = Jeckle::Setup.registered_apis.fetch(registered_api_name)
-      rescue KeyError => e
-        raise Jeckle::NoSuchAPIError, registered_api_name
-      end
-
-      def api_mapping
-        @api_mapping ||= {}
-      end
-
-      def find(id)
-        endpoint = "#{resource_name}/#{id}"
-        attributes = run_request(endpoint).response.body
-
-        new attributes
-      end
-
-      def search(params = {})
-        response   = run_request(resource_name, params).response.body || []
-        collection = response.kind_of?(Array) ? response : response[resource_name]
-
-        Array(collection).collect { |attrs| new attrs }
-      end
-
-      def run_request(endpoint, options = {})
-        Jeckle::Request.run api_mapping[:default_api], endpoint, options
-      end
+      base.send :include, Jeckle::Model
+      base.send :include, Jeckle::HTTP
+      base.send :include, Jeckle::RESTActions
     end
   end
 end

data/lib/jeckle/rest_actions.rb

@@ -0,0 +1,23 @@
+module Jeckle
+  module RESTActions
+    def self.included(base)
+      base.send :extend, Jeckle::RESTActions::Collection
+    end
+
+    module Collection
+      def find(id)
+        endpoint = "#{resource_name}/#{id}"
+        attributes = run_request(endpoint).response.body
+
+        new attributes
+      end
+
+      def search(params = {})
+        response   = run_request(resource_name, params).response.body || []
+        collection = response.kind_of?(Array) ? response : response[resource_name]
+
+        Array(collection).collect { |attrs| new attrs }
+      end
+    end
+  end
+end

data/lib/jeckle/version.rb

@@ -1,3 +1,3 @@
 module Jeckle
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/jeckle.rb

@@ -5,7 +5,7 @@ require 'virtus'
 
 require 'jeckle/version'
 
-%w(setup api model request resource errors).each do |file_name|
+%w(setup api model request http rest_actions resource errors).each do |file_name|
   require "jeckle/#{file_name}"
 end
 

data/spec/fixtures/jeckle_config.rb

@@ -1,31 +1,33 @@
-Jeckle::Setup.register(:my_super_api) do |api|
-  api.base_uri = 'http://my-super-api.com.br'
-  api.headers = { 'Content-Type' => 'application/json' }
-  api.logger = Logger.new(STDOUT)
-  api.basic_auth = { username: 'steven_seagal', password: 'youAlwaysLose' }
-  api.namespaces = { prefix: 'api', version: 'v1' }
-  api.params = { hello: 'world' }
-  api.open_timeout = 2
-  api.read_timeout = 5
+Jeckle.configure do |config|
+  config.register :my_super_api do |api|
+    api.base_uri = 'http://my-super-api.com.br'
+    api.headers = { 'Content-Type' => 'application/json' }
+    api.logger = Logger.new(STDOUT)
+    api.basic_auth = { username: 'steven_seagal', password: 'youAlwaysLose' }
+    api.namespaces = { prefix: 'api', version: 'v1' }
+    api.params = { hello: 'world' }
+    api.open_timeout = 2
+    api.read_timeout = 5
 
-  api.middlewares do
-    request :json
-    response :json
-    response :raise_error
+    api.middlewares do
+      request :json
+      response :json
+      response :raise_error
+    end
   end
-end
 
-Jeckle::Setup.register(:another_api) do |api|
-  api.base_uri = 'http://another-api.com.br'
-  api.headers = { 'Content-Type' => 'application/json' }
-  api.logger = Logger.new(STDOUT)
-  api.basic_auth = { username: 'heisenberg', password: 'metaAfetaAMina' }
-  api.namespaces = { prefix: 'api', version: 'v5' }
-  api.params = { hi: 'there' }
+  config.register :another_api do |api|
+    api.base_uri = 'http://another-api.com.br'
+    api.headers = { 'Content-Type' => 'application/json' }
+    api.logger = Logger.new(STDOUT)
+    api.basic_auth = { username: 'heisenberg', password: 'metaAfetaAMina' }
+    api.namespaces = { prefix: 'api', version: 'v5' }
+    api.params = { hi: 'there' }
 
-  api.middlewares do
-    request :json
-    response :json
-    response :raise_error
+    api.middlewares do
+      request :json
+      response :json
+      response :raise_error
+    end
   end
 end

data/spec/fixtures/resources/fake_resource.rb

@@ -1,7 +1,7 @@
 class FakeResource
   include Jeckle::Resource
 
-  default_api :my_super_api
+  api :my_super_api
 
   attribute :id, Integer
 end

data/spec/jeckle/http_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+RSpec.describe Jeckle::HTTP do
+  describe '.resource_name' do
+    it 'returns resource name based on class name' do
+      expect(FakeResource.resource_name).to eq 'fake_resources'
+    end
+
+    context 'when resource class is namespaced' do
+      before do
+        MySuperApi = Module.new
+        MySuperApi::FakeResource = Class.new(::FakeResource)
+      end
+
+      it 'ignores namespace' do
+        expect(MySuperApi::FakeResource.resource_name).to eq 'fake_resources'
+      end
+    end
+  end
+
+  describe '.api_mapping' do
+    it 'returns a hash containing default api' do
+      expect(FakeResource.api_mapping).to match(
+        default_api: an_instance_of(Jeckle::API)
+      )
+    end
+
+    context 'when resource is inherited' do
+      let(:inherited_class) { Class.new(FakeResource) }
+
+      it "contains the parent's api_mapping" do
+        expect(inherited_class.api_mapping).to eq FakeResource.api_mapping
+      end
+
+      context 'when api_mapping is changed' do
+        it "does not affect the parent" do
+          inherited_class.api :another_api
+
+          expect(FakeResource.api_mapping).not_to eq inherited_class.api_mapping
+          expect(FakeResource.api_mapping[:default_api]).to eq Jeckle::Setup.registered_apis[:my_super_api]
+        end
+      end
+    end
+  end
+
+  describe '.default_api' do
+    context 'when defining a registered API via Jeckle::Setup' do
+      it 'returns the assigned API' do
+        expect(FakeResource.api :my_super_api).to be_kind_of Jeckle::API
+      end
+
+      it 'assigns API do api_mapping' do
+        expect(FakeResource.api_mapping).to have_key :default_api
+      end
+    end
+
+    context 'when defining an inexistent API' do
+      it 'raises NoSuchAPIError' do
+        expect { FakeResource.api :unknown_api }.to raise_error Jeckle::NoSuchAPIError
+      end
+    end
+  end
+end

data/spec/jeckle/resource_spec.rb

@@ -3,8 +3,6 @@ require 'spec_helper'
 RSpec.describe Jeckle::Resource do
   subject(:fake_resource) { FakeResource.new }
 
-  let(:api) { FakeResource.api_mapping[:default_api] }
-
   it 'includes jeckle/model' do
     expect(FakeResource.ancestors).to include Jeckle::Model
   end
@@ -13,131 +11,11 @@ RSpec.describe Jeckle::Resource do
     expect(FakeResource.ancestors).to include ActiveModel::Naming
   end
 
-  describe '.resource_name' do
-    it 'returns resource name based on class name' do
-      expect(FakeResource.resource_name).to eq 'fake_resources'
-    end
-
-    context 'when resource class is namespaced' do
-      before do
-        MySuperApi = Module.new
-        MySuperApi::FakeResource = Class.new(::FakeResource)
-      end
-
-      it 'ignores namespace' do
-        expect(MySuperApi::FakeResource.resource_name).to eq 'fake_resources'
-      end
-    end
-  end
-
-  describe '.api_mapping' do
-    it 'returns a hash containing default api' do
-      expect(FakeResource.api_mapping).to match(
-        default_api: an_instance_of(Jeckle::API)
-      )
-    end
-
-    context 'when resource is inherited' do
-      let(:inherited_class) { Class.new(FakeResource) }
-
-      it "contains the parent's api_mapping" do
-        expect(inherited_class.api_mapping).to eq FakeResource.api_mapping
-      end
-
-      context 'when api_mapping is changed' do
-        it "does not affect the parent" do
-          inherited_class.default_api :another_api
-
-          expect(FakeResource.api_mapping).not_to eq inherited_class.api_mapping
-          expect(FakeResource.api_mapping[:default_api]).to eq Jeckle::Setup.registered_apis[:my_super_api]
-        end
-      end
-    end
-  end
-
-  describe '.default_api' do
-    context 'when defining a registered API via Jeckle::Setup' do
-      it 'returns the assigned API' do
-        expect(FakeResource.default_api :my_super_api).to be_kind_of Jeckle::API
-      end
-
-      it 'assigns API do api_mapping' do
-        expect(FakeResource.api_mapping).to have_key :default_api
-      end
-    end
-
-    context 'when defining an inexistent API' do
-      it 'raises NoSuchAPIError' do
-        expect { FakeResource.default_api :unknown_api }.to raise_error Jeckle::NoSuchAPIError
-      end
-    end
+  it 'includes jeckle http' do
+    expect(FakeResource.ancestors).to include Jeckle::HTTP
   end
 
-  describe '.find' do
-    let(:fake_request) { OpenStruct.new response: OpenStruct.new(body: { id: 1001 }) }
-
-    it 'calls default API connection with GET' do
-      expect(Jeckle::Request).to receive(:run)
-        .with(api, 'fake_resources/1001', {}).and_return(fake_request)
-
-      FakeResource.find 1001
-    end
-
-    it 'returns an instance of resource' do
-      allow(Jeckle::Request).to receive(:run).and_return(fake_request)
-
-      expect(FakeResource.find 1001).to be_an_instance_of(FakeResource)
-    end
-  end
-
-  describe '.search' do
-    let(:fake_request) { OpenStruct.new response: OpenStruct.new(body: body) }
-
-    let(:query) { { name: 'cocada' } }
-
-    context 'when there are results WITHOUT root node' do
-      let(:body) { [{ id: 1001 }, { id: 1002 }] }
-
-      it 'calls default API connection with GET and search params' do
-        expect(Jeckle::Request).to receive(:run)
-          .with(api, 'fake_resources', query).and_return(fake_request)
-
-        FakeResource.search query
-      end
-
-      it 'returns an Array of resources' do
-        allow(Jeckle::Request).to receive(:run).and_return(fake_request)
-
-        expect(FakeResource.search query).to match [
-          an_instance_of(FakeResource),
-          an_instance_of(FakeResource)
-        ]
-      end
-    end
-
-    context 'when there are results WITH root node' do
-      let(:body) do
-        { 'fake_resources' => [{ id: 1001 }, { id: 1002 } ] }
-      end
-
-      it 'returns an Array of resources' do
-        allow(Jeckle::Request).to receive(:run).and_return(fake_request)
-
-        expect(FakeResource.search query).to match [
-          an_instance_of(FakeResource),
-          an_instance_of(FakeResource)
-        ]
-      end
-    end
-
-    context 'when there are no results' do
-      let(:fake_request) { OpenStruct.new response: OpenStruct.new(body: nil) }
-
-      it 'returns an empty Array' do
-        allow(Jeckle::Request).to receive(:run).and_return(fake_request)
-
-        expect(FakeResource.search query).to match []
-      end
-    end
+  it 'includes jeckle rest actions' do
+    expect(FakeResource.ancestors).to include Jeckle::RESTActions
   end
 end

data/spec/jeckle/rest_actions_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+RSpec.describe Jeckle::RESTActions do
+  let(:api) { FakeResource.api_mapping[:default_api] }
+
+  describe '.find' do
+    let(:fake_request) { OpenStruct.new response: OpenStruct.new(body: { id: 1001 }) }
+
+    it 'calls default API connection with GET' do
+      expect(Jeckle::Request).to receive(:run)
+        .with(api, 'fake_resources/1001', {}).and_return(fake_request)
+
+      FakeResource.find 1001
+    end
+
+    it 'returns an instance of resource' do
+      allow(Jeckle::Request).to receive(:run).and_return(fake_request)
+
+      expect(FakeResource.find 1001).to be_an_instance_of(FakeResource)
+    end
+  end
+
+  describe '.search' do
+    let(:fake_request) { OpenStruct.new response: OpenStruct.new(body: body) }
+
+    let(:query) { { name: 'cocada' } }
+
+    context 'when there are results WITHOUT root node' do
+      let(:body) { [{ id: 1001 }, { id: 1002 }] }
+
+      it 'calls default API connection with GET and search params' do
+        expect(Jeckle::Request).to receive(:run)
+          .with(api, 'fake_resources', query).and_return(fake_request)
+
+        FakeResource.search query
+      end
+
+      it 'returns an Array of resources' do
+        allow(Jeckle::Request).to receive(:run).and_return(fake_request)
+
+        expect(FakeResource.search query).to match [
+          an_instance_of(FakeResource),
+          an_instance_of(FakeResource)
+        ]
+      end
+    end
+
+    context 'when there are results WITH root node' do
+      let(:body) do
+        { 'fake_resources' => [{ id: 1001 }, { id: 1002 } ] }
+      end
+
+      it 'returns an Array of resources' do
+        allow(Jeckle::Request).to receive(:run).and_return(fake_request)
+
+        expect(FakeResource.search query).to match [
+          an_instance_of(FakeResource),
+          an_instance_of(FakeResource)
+        ]
+      end
+    end
+
+    context 'when there are no results' do
+      let(:fake_request) { OpenStruct.new response: OpenStruct.new(body: nil) }
+
+      it 'returns an empty Array' do
+        allow(Jeckle::Request).to receive(:run).and_return(fake_request)
+
+        expect(FakeResource.search query).to match []
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeckle
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomas D'Stefano
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -135,6 +135,7 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
+- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -143,18 +144,22 @@ files:
 - lib/jeckle.rb
 - lib/jeckle/api.rb
 - lib/jeckle/errors.rb
+- lib/jeckle/http.rb
 - lib/jeckle/model.rb
 - lib/jeckle/request.rb
 - lib/jeckle/resource.rb
+- lib/jeckle/rest_actions.rb
 - lib/jeckle/setup.rb
 - lib/jeckle/version.rb
 - spec/fixtures/jeckle_config.rb
 - spec/fixtures/models/fake_model.rb
 - spec/fixtures/resources/fake_resource.rb
 - spec/jeckle/api_spec.rb
+- spec/jeckle/http_spec.rb
 - spec/jeckle/model_spec.rb
 - spec/jeckle/request_spec.rb
 - spec/jeckle/resource_spec.rb
+- spec/jeckle/rest_actions_spec.rb
 - spec/jeckle/setup_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
@@ -187,9 +192,11 @@ test_files:
 - spec/fixtures/models/fake_model.rb
 - spec/fixtures/resources/fake_resource.rb
 - spec/jeckle/api_spec.rb
+- spec/jeckle/http_spec.rb
 - spec/jeckle/model_spec.rb
 - spec/jeckle/request_spec.rb
 - spec/jeckle/resource_spec.rb
+- spec/jeckle/rest_actions_spec.rb
 - spec/jeckle/setup_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb