api-resource 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5dae0339d240421eb712387cb2a22f95da96640
+  data.tar.gz: ec15e6fe4b2179873490059e11ca1811823ddee1
+SHA512:
+  metadata.gz: 1be26aca4ea7a90274e8ebe02dec7c3c18bcc51df974dfee5c3e9f471464cf490e5e68405e6cfd55155e18055d23c01cd7b458e8341aed78235476b005822b96
+  data.tar.gz: e5daac829ddb90523e31364302d53eec67046474c2ae8915921245828b0c6a50079e61fcaf2a2a9d1c38f3bc0c950792139f4b593667f1f39ad26e1b25832069

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Wizypay - Chaker Nakhli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Api::Resource
+
+Library for accessing Restful APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-resource'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-resource
+
+## Usage
+
+TODO: Write usage instructions here

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/api-resource/resource.rb

@@ -0,0 +1,113 @@
+require 'rest_client'
+require 'active_model'
+require 'active_model/model'
+require 'active_model/serializers/json'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/to_param'
+
+class Resource
+
+  include ActiveModel::Model
+  include ActiveModel::Serializers::JSON
+
+  class_attribute :base_url
+  class_attribute :hmac
+  class_attribute :api_id
+  class_attribute :api_secret
+  class_attribute :auth_prefix
+
+  def self.with_hmac(api_id, api_secret, auth_prefix='APIAuth')
+    self.hmac        = true
+    self.api_id      = api_id
+    self.api_secret  = api_secret
+    self.auth_prefix = auth_prefix
+  end
+
+  def initialize(hash=nil)
+    self.attributes = hash if hash
+  end
+
+  def self.resource_name
+    self.to_s.tableize
+  end
+
+  def self.find(id)
+    result = client(:get, {}, resource_name, id)
+    self.new.from_json(result)
+  end
+
+  def self.all
+    result = client(:get, {}, resource_name)
+    array  = JSON.parse(result)
+    array.map { |h| self.new(h) }
+  end
+
+  def self.where(options, verb=:get)
+    result = client(verb, *(verb==:get ? [{}, "#{resource_name}?#{options.to_param}"] : [options, resource_name]))
+    array = JSON.parse(result)
+    array.map { |h| self.new(h) }
+  end
+
+  def attributes
+    instance_values.with_indifferent_access
+  end
+
+  protected
+
+  def attributes=(hash)
+    hash.each do |key, value|
+      if respond_to? "#{key}="
+        send("#{key}=", value)
+      else
+        child_class = self.class.load_class(key)
+        if child_class && child_class < Resource
+          if value.is_a?(Hash)
+            child_value = child_class.new(value)
+            define_singleton_method(key) { child_value }
+          elsif value.is_a?(Array)
+            child_values = value.map { |h| child_class.new(h) }
+            define_singleton_method(key) { child_values }
+          end
+        end
+      end
+    end
+  end
+
+  def self.method_missing(m, *args, &_)
+    unless args.empty?
+      by_method_match = /^by_(.+)/.match(m)
+      if by_method_match
+        parent_resource_name = by_method_match[1]
+        with_parent_resource(args[0], parent_resource_name)
+      end
+    end
+  end
+
+  def self.load_class(plural_resource_name)
+    plural_resource_name.to_s.singularize.classify.constantize rescue nil
+  end
+
+  def self.with_parent_resource(parent_resource_id, parent_resource_name)
+    result = client(:get, {}, parent_resource_name.pluralize, parent_resource_id, self.resource_name)
+    hashes = JSON.parse(result)
+    hashes.map { |h| self.new(h) }
+  end
+
+  def self.client(verb, params, *paths)
+    url        = base_url
+    url        += '/' unless url.end_with?('/')
+    url        = url + paths.join('/')
+    headers    = { accept: :json }
+    req_params = { url: url, method: verb, headers: headers }
+    if verb == :get
+      headers[:params] = params
+    else
+      req_params[:payload] = params
+    end
+    req = RestClient::Request.new(req_params)
+    if hmac
+      req.sign!(api_id, api_secret, auth_prefix)
+    end
+    req.execute
+  end
+end

data/lib/api-resource/version.rb

@@ -0,0 +1,3 @@
+module ApiResource
+  VERSION = '0.1.0'
+end

data/lib/api-resource.rb

@@ -0,0 +1 @@
+require_relative 'api-resource/resource'

data/spec/resource_spec.rb

@@ -0,0 +1,142 @@
+RSpec.describe Resource do
+
+  class BlogResource < Resource
+    self.base_url = 'http://api.example.com'
+  end
+
+  class Category < BlogResource
+    attr_accessor :id, :name
+  end
+
+  class Blog < BlogResource
+    attr_accessor :id, :title
+  end
+
+  class Tag < BlogResource
+    attr_accessor :id, :name
+  end
+
+  context '#find' do
+    it 'creates the resource when found' do
+      resource_values = { 'id' => 1257, 'title' => 'Hello' }
+      resource_id     = 3
+      stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
+          with(headers: { 'Accept' => 'application/json' }).
+          to_return(status: 200, body: resource_values.to_json)
+
+      result = Blog.find(resource_id)
+      expect(result).to be_a Blog
+      expect(result.attributes).to match (resource_values)
+    end
+  end
+
+  context '#all' do
+    it 'fetches all resourced' do
+      resource_values = [{ id: 1257, title: 'Hello' },
+                         { id: 33, title: 'World' },
+                         { id: 38, title: 'Bonjour!' }]
+
+      stub_request(:get, "#{Blog.base_url}/blogs").
+          with(headers: { 'Accept' => 'application/json' }).
+          to_return(status: 200, body: resource_values.to_json)
+
+      blogs = Blog.all
+
+      expect(blogs).to be_a Array
+      blogs.each { |e| expect(e).to be_a Blog }
+      expect(blogs.map { |e| e.attributes }).to match (resource_values)
+    end
+  end
+
+  context '#where' do
+    before do
+      @resource_values = [{ id: 1257, title: 'Hello' },
+                          { id: 33, title: 'World' },
+                          { id: 38, title: 'Bonjour!' }]
+    end
+    it 'fetches resourced filtered by query string with GET' do
+      stub_request(:get, "#{Blog.base_url}/blogs?title=hello+world&tags%5B%5D=hello&tags%5B%5D=first&tags%5B%5D=greeting").
+          with(headers: { 'Accept' => 'application/json' }).
+          to_return(status: 200, body: @resource_values.to_json)
+
+      blogs = Blog.where(title: 'hello world', tags: ['hello', 'first', 'greeting'])
+
+      expect(blogs).to be_a Array
+      blogs.each { |e| expect(e).to be_a Blog }
+      expect(blogs.map { |e| e.attributes }).to match (@resource_values)
+    end
+
+    it 'fetches resourced filtered by query string with POST' do
+      stub_request(:post, "#{Blog.base_url}/blogs").
+          with(headers: { 'Accept' => 'application/json', 'Content-Type' => 'application/x-www-form-urlencoded' },
+               body:    'title=hello%20world&tags[]=hello&tags[]=first&tags[]=greeting').
+          to_return(status: 200, body: @resource_values.to_json)
+
+      blogs = Blog.where({ title: 'hello world', tags: ['hello', 'first', 'greeting'] }, :post)
+
+      expect(blogs).to be_a Array
+      blogs.each { |e| expect(e).to be_a Blog }
+      expect(blogs.map { |e| e.attributes }).to match (@resource_values)
+    end
+  end
+
+  context '#by_parent_resource' do
+    it 'fetches resource nested with parent resource' do
+      resource_values = [{ id: 1257, title: 'Hello' },
+                         { id: 33, title: 'World' }]
+      resource_id     = 3
+
+      stub_request(:get, "#{Blog.base_url}/tags/#{resource_id}/blogs").
+          with(headers: { 'Accept' => 'application/json' }).
+          to_return(status: 200, body: resource_values.to_json)
+
+      blogs = Blog.by_tag(resource_id)
+
+      expect(blogs).to be_a Array
+      blogs.each { |e| expect(e).to be_a Blog }
+      expect(blogs.map { |e| e.attributes }).to match (resource_values)
+    end
+  end
+
+  context '#child_ressources' do
+    it 'has_many association with inlined json' do
+      resource_values = {
+          id:   1257, title: 'Tarte a la creme',
+          tags: [{ id: 33, name: 'food' }, { id: 39, name: 'cuisine' }]
+      }
+      resource_id     = 3
+
+      stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
+          with(headers: { 'Accept' => 'application/json' }).
+          to_return(status: 200, body: resource_values.to_json)
+
+      blog = Blog.find(resource_id)
+      expect(blog).to be_a Blog
+      expect(blog.attributes).to match(resource_values.except :tags)
+
+      tags = blog.tags
+      expect(tags).to be_a Array
+      tags.each { |e| expect(e).to be_a Tag }
+      expect(tags.map { |e| e.attributes }).to match (resource_values[:tags])
+    end
+    it 'has_one association with inlined json' do
+      resource_values = {
+          id:       1257, title: 'Tarte a la creme',
+          category: { id: 33, name: 'Hobbies' }
+      }
+      resource_id     = 3
+
+      stub_request(:get, "#{Blog.base_url}/blogs/#{resource_id}").
+          with(headers: { 'Accept' => 'application/json' }).
+          to_return(status: 200, body: resource_values.to_json)
+
+      blog = Blog.find(resource_id)
+      expect(blog).to be_a Blog
+      expect(blog.attributes).to match(resource_values.except :category)
+
+      category = blog.category
+      expect(category).to be_a Category
+      expect(category.attributes).to match(resource_values[:category])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,88 @@
+require 'rspec'
+require 'api-resource'
+require 'webmock/rspec'
+
+# Conventionally, all specs live under a `spec` directory, which RSpec adds to
+# the `$LOAD_PATH`. The generated `.rspec` file contains `--require spec_helper`
+# which will cause this file to always be loaded, without a need to explicitly
+# require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: api-resource
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chaker Nakhli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simple-hmac
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: 
+email:
+- chaker@wizypay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/api-resource.rb
+- lib/api-resource/resource.rb
+- lib/api-resource/version.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.wizypay.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: A lightweight REST API access library.
+test_files:
+- spec/resource_spec.rb
+- spec/spec_helper.rb