jeckle 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fedf58b9859236e613f70bb3cfaf8f34fcba6cd
-  data.tar.gz: f5671e5ec06652de45455208795669c487decaa8
+  metadata.gz: f21821c33e6f22dc7c478aea1e3362943909fa73
+  data.tar.gz: 7a95a145731b2d5b00c025bff09d54e8d1572531
 SHA512:
-  metadata.gz: d052c4ef86214fcd06f9f84c9f959e02c5c83c2d3560652f8d0fb5206f3a090f8b09d8662cd500bb125206f20cd3d7f44d2dcf33a464bfdbac66b7f99ef6d0a1
-  data.tar.gz: 58f383cc88ac992dbef23a98e2c5af620d0c14fdf774373f8a8aa9f07a0b0f722ee496caa03769fd4324c6e7b3e060c0f65bb12f0e424e8ddb56b18da4a86ffc
+  metadata.gz: edd8cae15a4e4779c72e8e0d1fc93e2038d467c2d9089f751472e6c10bbf2e284f902247c32f1f8c3211f409fcdb7d2d8fc92274092d8d47050111c86a502d70
+  data.tar.gz: 7a3f7ebe5e921202cea52c038e77506e9a69ecb6a3568cced27f0c35c702b60f3c21cfadb3189a063e5d622636be65e64b6c29366a6c6d1923dd41d589c79c6a

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - ruby-head
   - ruby
   - jruby
+  - 2.2.2
   - 2.1.0
   - 2.0.0
   - 1.9.3

data/History.markdown

@@ -1,3 +1,8 @@
+## v.0.3.1
+
+* Add attribute aliasing
+* Add possibility to change the resource name when call Resource.search.
+
 ## v.0.3.0
 
 * Change Jeckle::Resource.default_api to Jeckle::Resource.api
@@ -8,4 +13,4 @@
 
 ## v.0.2.0
 
-* Add Jeckle middlewares
+* Add Jeckle middlewares

data/README.md

@@ -20,19 +20,25 @@ Let third party APIs be Heckle for your app's Jeckle.
 
 Add this line to your application's Gemfile:
 
-    gem 'jeckle'
+```ruby
+gem 'jeckle'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
-### For Rails applications
+## Usage
 
-We recommend to create a initializer:
+### Configuring an API
 
-```ruby
-# config/initializers/jeckle.rb
+Let's say you'd like to connect your app to Dribbble.com - a community of designers sharing screenshots of their work, process, and projects.
+
+First, you would need to configure the API:
 
+```ruby
 Jeckle.configure do |config|
   config.register :some_service do |api|
     api.base_uri = 'http://api.someservice.com'
@@ -46,17 +52,13 @@ Jeckle.configure do |config|
 end
 ```
 
-And then put your API stuff scoped inside a `services` folder:
-
-```ruby
-# app/services/some_service/models/my_resource.rb
+### Mapping resources
 
-module SomeService
-  module Models
-    class MyResource
-      include Jeckle::Resource
+Following the previous example, Dribbble.com consists of pieces of web designers work called "Shots". Each shot has the attributes `id`, `name`, `url` and `image_url`. A Jeckle resource representing Dribbble's shots would be something like this:
 
-      api :some_service
+```ruby
+class Shot
+  include Jeckle::Resource
 
       attribute :id
     end
@@ -64,9 +66,60 @@ module SomeService
 end
 ```
 
+### Fetching data
+
+The resource class allows us to search shots through HTTP requests to the API, based on the provided information. For example, we can find a specific shot by providing its id to the `find` method:
+
+```ruby
+# GET http://api.dribbble.com/shots/1600459
+shot = Shot.find 1600459
+```
+
+That will return a `Shot` instance, containing the shot info:
+
+```ruby
+shot.id
+=> 1600459
+
+shot.name
+=> "Daryl Heckle And Jeckle Oates"
+
+shot.image_url
+=> "https://d13yacurqjgara.cloudfront.net/users/85699/screenshots/1600459/daryl_heckle_and_jeckle_oates-dribble.jpg"
+```
+
+You can also look for many shots matching one or more attributes, by using the `search` method:
+
+```ruby
+# GET http://api.dribbble.com/shots?name=avengers
+shots = Shot.search name: 'avengers'
+```
+
+### Attribute Aliasing
+
+Sometimes you want to call the API's attributes something else, either because their names aren't very concise or because they're out of you app's convention. If that's the case, you can add an `as` option:
+
+```ruby
+attribute :thumbnailSize, String, as: :thumbnail_size
+```
+
+Both mapping will work:
+
+```ruby
+shot.thumbnailSize
+=> "50x50"
+
+shot.thumbnail_size
+=> "50x50"
+```
+
+We're all set! Now we can expand the mapping of our API, e.g to add ability to search Dribbble Designer directory by adding Designer class, or we can expand the original mapping of Shot class to include more attributes, such as tags or comments.
+
+## Examples
+
+You can see more examples here: [https://github.com/tomas-stefano/jeckle/tree/master/examples](https://github.com/tomas-stefano/jeckle/tree/master/examples)
+
 ## Roadmap
 
-- Faraday middleware abstraction
-- Per action API
-- Comprehensive restful actions
-- Testability
+Follow [GitHub's milestones](https://github.com/tomas-stefano/jeckle/milestones)
+>>>>>>> 14eb4ce... Merge pull request #49 from tomas-stefano/attribute-mapping

data/examples/dribbble.rb

@@ -1,8 +1,13 @@
 require 'jeckle'
 
+# Here is an example using the Dribbble API
+
 Jeckle.configure do |config|
   config.register :dribbble do |api|
     api.base_uri = 'http://api.dribbble.com'
+    api.middlewares do
+      response :json
+    end
   end
 end
 
@@ -14,7 +19,7 @@ class Shot
   attribute :id, Integer
   attribute :name, String
   attribute :url, String
-  attribute :image_url, String
+  attribute :image_url, String, as: :image
 end
 
 shot = Shot.find 1600459
@@ -25,5 +30,5 @@ shot.id
 shot.name
 # => Daryl Heckle And Jeckle Oates
 
-shot.image_url
+puts "The shot image URL is #{shot.image}"
 # => https://d13yacurqjgara.cloudfront.net/users/85699/screenshots/1600459/daryl_heckle_and_jeckle_oates-dribble.jpg

data/jeckle.gemspec

@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activemodel', '>= 4.0'
   spec.add_dependency 'faraday', '~> 0.9'
   spec.add_dependency 'faraday_middleware'
-  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'virtus'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '>= 1.6'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rspec', '~> 3.2'
 
   if RUBY_ENGINE == 'rbx'
     spec.add_development_dependency 'rubinius-compiler'
@@ -34,6 +34,6 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'pry'
   else
     spec.add_development_dependency 'pry-nav' if RUBY_VERSION < '2.0.0'
-    spec.add_development_dependency 'pry-byebug' if RUBY_VERSION >= '2.0.0'
+    spec.add_development_dependency 'pry-byebug', '3.1.0' if RUBY_VERSION >= '2.0.0'
   end
 end

data/lib/jeckle.rb

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

data/lib/jeckle/attribute_aliasing.rb

@@ -0,0 +1,13 @@
+module Jeckle
+  module AttributeAliasing
+    def attribute(name, coercion, options = {})
+      if custom_name = options.delete(:as)
+        super(custom_name, coercion, options)
+
+        alias_attribute name, custom_name
+      else
+        super
+      end
+    end
+  end
+end

data/lib/jeckle/resource.rb

@@ -6,6 +6,8 @@ module Jeckle
       base.send :include, Jeckle::Model
       base.send :include, Jeckle::HTTP
       base.send :include, Jeckle::RESTActions
+
+      base.send :extend, Jeckle::AttributeAliasing
     end
   end
 end

data/lib/jeckle/rest_actions.rb

@@ -13,11 +13,13 @@ module Jeckle
       end
 
       def search(params = {})
-        response   = run_request(resource_name, params).response.body || []
+        custom_resource_name = params.delete(:resource_name) if params.kind_of?(Hash)
+
+        response   = run_request(custom_resource_name || resource_name, params: params).response.body || []
         collection = response.kind_of?(Array) ? response : response[resource_name]
 
         Array(collection).collect { |attrs| new attrs }
       end
     end
   end
-end
+end

data/lib/jeckle/setup.rb

@@ -1,6 +1,6 @@
 module Jeckle
   class Setup
-    # Register apis, providing all the configurations to it.
+    # Register APIs, providing all the configurations to it.
     #
     # @example
     #

data/lib/jeckle/version.rb

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

data/spec/lib/jeckle/attribute_aliasing_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+class AttributeAliasingResource
+  include Jeckle::Resource
+
+  attribute :firstName, String, as: :first_name
+end
+
+RSpec.describe Jeckle::AttributeAliasing do
+  let(:first_name) { 'First Name' }
+  let(:resource) { AttributeAliasingResource.new(firstName: first_name) }
+
+  describe '.attribute' do
+    it 'initializes attributes by :as options' do
+      expect(resource.first_name).to eq first_name
+      expect(resource.firstName).to eq first_name
+    end
+  end
+end

data/spec/{jeckle → lib/jeckle}/rest_actions_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe Jeckle::RESTActions do
 
       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)
+          .with(api, 'fake_resources', { params: query }).and_return(fake_request)
 
         FakeResource.search query
       end
@@ -69,5 +69,18 @@ RSpec.describe Jeckle::RESTActions do
         expect(FakeResource.search query).to match []
       end
     end
+
+    context 'when the endpoint is overwritten' do
+      let(:endpoint) { 'custom_endpoint' }
+      let(:query) { { resource_name: endpoint, name: 'cocada' } }
+      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, endpoint, params: query).and_return(fake_request)
+
+        FakeResource.search query
+      end
+    end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jeckle
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Tomas D'Stefano
@@ -9,120 +9,120 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 description: Simple module for building client APIs
 email:
 - tomas_stefano@successoft.com
@@ -131,9 +131,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - History.markdown
 - LICENSE.txt
@@ -143,6 +143,7 @@ files:
 - jeckle.gemspec
 - lib/jeckle.rb
 - lib/jeckle/api.rb
+- lib/jeckle/attribute_aliasing.rb
 - lib/jeckle/errors.rb
 - lib/jeckle/http.rb
 - lib/jeckle/model.rb
@@ -154,13 +155,14 @@ files:
 - 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/lib/jeckle/api_spec.rb
+- spec/lib/jeckle/attribute_aliasing_spec.rb
+- spec/lib/jeckle/http_spec.rb
+- spec/lib/jeckle/model_spec.rb
+- spec/lib/jeckle/request_spec.rb
+- spec/lib/jeckle/resource_spec.rb
+- spec/lib/jeckle/rest_actions_spec.rb
+- spec/lib/jeckle/setup_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb
 homepage: https://github.com/tomas-stefano/jeckle
@@ -173,17 +175,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple module for building client APIs
@@ -191,12 +193,13 @@ test_files:
 - 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/lib/jeckle/api_spec.rb
+- spec/lib/jeckle/attribute_aliasing_spec.rb
+- spec/lib/jeckle/http_spec.rb
+- spec/lib/jeckle/model_spec.rb
+- spec/lib/jeckle/request_spec.rb
+- spec/lib/jeckle/resource_spec.rb
+- spec/lib/jeckle/rest_actions_spec.rb
+- spec/lib/jeckle/setup_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples.rb