facile 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+# certs
+*.key
+*.crt
+
+# misc
+.DS_Store
+
+# ruby
+.bundle
+.gem
+.bin
+
+# testing
+.rspec

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in facile.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    facile (0.0.1)
+      activesupport (~> 3.1)
+      addressable
+      faraday
+      hashie
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.15)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.4)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.0.4)
+      guard (>= 2.1.1)
+      rspec (~> 2.14)
+    hashie (2.0.5)
+    i18n (0.6.5)
+    listen (2.2.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-nc (0.0.6)
+      rspec (~> 2.9)
+      terminal-notifier (~> 1.4.2)
+    slop (3.4.7)
+    terminal-notifier (1.4.2)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  facile!
+  guard
+  guard-rspec
+  rake
+  rspec
+  rspec-nc

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simon Thulbourn
+
+MIT License
+
+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,48 @@
+# Facile
+
+[![Code
+Climate](https://codeclimate.com/github/sthulb/facile.png)](https://codeclimate.com/github/sthulb/facile)
+[![Build
+Status](https://travis-ci.org/sthulb/facile.png?branch=master)](https://travis-ci.org/sthulb/facile)
+
+API simplicity gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'facile'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install facile
+
+## Usage
+
+TODO: Write usage instructions here
+
+An example script, to fetch the weather data from the BBC.
+```ruby
+require 'facile'
+
+class Foo < Facile::Api
+  self.url = 'http://open.live.bbc.co.uk/weather/feeds/en/{id}/3dayforecast.json'
+end
+
+foo = Foo.find('2643743')
+
+# gets forecast date for the first day.
+foo.forecastContent.forecasts.first.date
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/facile.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facile/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'facile'
+  spec.version       = Facile::VERSION
+  spec.authors       = ['Simon Thulbourn']
+  spec.email         = ['simon+github@thulbourn.com']
+  spec.description   = 'Facile: API simplicity gem'
+  spec.summary       = 'Facile: API simplicity gem'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'activesupport', '~> 3.1'
+  spec.add_runtime_dependency 'addressable'
+  spec.add_runtime_dependency 'hashie'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-nc'
+end

data/lib/facile/api.rb

@@ -0,0 +1,55 @@
+require 'addressable/template'
+require 'active_support/core_ext/class/attribute_accessors'
+
+class Facile::Api
+  cattr_accessor :url, :headers, :body, :params, :options
+
+  def self.find(*args)
+    id, options = args[0] || nil, args[1] || {}
+    new().find(id, options)
+  end
+
+  def initialize(response = {})
+    @response = response if !response.empty?
+  end
+
+  def method_missing(method, *args, &block)
+    raise NoMethodError, "'#{method}' doesn't exist" if response.nil?
+
+    response.send(method)
+  end
+
+  def find(id, options = {})
+    url = generate_url(id, self.class.url)
+    req_options = request_options(url)
+
+    self.class.new(create_request(req_options).body)
+  end
+
+  protected
+  attr_reader :response
+
+  def create_request(req_options = {})
+    req = Facile::Request.new(req_options)
+
+    req.go
+  end
+
+  def generate_url(id, url)
+    template = Addressable::Template.new(url)
+    expanded = template.partial_expand(:id => id)
+
+    expanded.pattern
+  end
+
+  def request_options(url)
+    {
+      :url => url,
+      :method => :get,
+      :headers => self.class.headers || {},
+      :options => self.class.options || {},
+      :body => self.class.body,
+      :params => self.class.params
+    }
+  end
+end

data/lib/facile/request.rb

@@ -0,0 +1,56 @@
+require 'faraday'
+
+class Facile::Request
+  def self.method_missing(method, *args, &block)
+    supported_methods = [:get, :post, :delete, :options, :patch, :put]
+
+    raise NoMethodError, "undefined method '#{method}'" if !supported_methods.include?(method)
+
+    args = args.count == 0 ? {} : args
+    args.merge!({:method => method || :get })
+
+    new(args, &block).go
+  end
+
+  def initialize(options = {}, &block)
+    options.merge!({ :method => :get }) unless options.has_key?(:method)
+
+    options.each do |k, v|
+      self.send("#{k}=", v) if respond_to?("#{k}=")
+    end
+
+    instance_eval(&block) if block_given?
+  end
+
+  def go
+    begin
+      conn = Faraday.new(options || {})
+
+      res = conn.send(method) do |req|
+        req.url url
+
+        headers.map { |k,v| req.headers[k] = v } if !headers.nil?
+        params.map { |k,v| req.params[k] = v } if !params.nil?
+        req.body = body if !body.nil?
+      end
+    rescue => e
+      raise e
+    end
+
+    parse_response(res)
+  end
+
+  def parse_response(res)
+    ::Facile::Response.new({
+      :request => self,
+      :response => res,
+      :status => res.status,
+      :headers => res.headers,
+      :raw_body => res.body,
+    })
+  end
+
+  attr_accessor :method, :headers, :url, :params, :body, :options
+
+  class RequestError < ::StandardError; end
+end

data/lib/facile/response/wrapper/json.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+class Facile::Response::Wrapper::Json
+  def initialize(body)
+    @body = body
+    @parsed_body = ::Facile::Response::Wrapper::Mash.new(JSON.parse(body))
+  end
+
+  def to_s
+    @body
+  end
+
+  attr_reader :body, :parsed_body
+end

data/lib/facile/response/wrapper/mash.rb

@@ -0,0 +1,10 @@
+require 'active_support/inflector'
+require 'hashie'
+
+class Facile::Response::Wrapper::Mash < Hashie::Mash
+  def convert_key(key)
+    key = key.to_s.underscore
+
+    super(key)
+  end
+end

data/lib/facile/response/wrapper/raw.rb

@@ -0,0 +1,15 @@
+class Facile::Response::Wrapper::Raw
+  def initialize(body)
+    @body = body
+  end
+
+  def parsed_body
+    @body
+  end
+
+  def to_s
+    @body
+  end
+
+  attr_accessor :body
+end

data/lib/facile/response/wrapper.rb

@@ -0,0 +1,40 @@
+class Facile::Response::Wrapper
+  autoload :Raw, 'facile/response/wrapper/raw'
+  autoload :Json, 'facile/response/wrapper/json'
+  autoload :Mash, 'facile/response/wrapper/mash'
+
+  def self.parse(body, options = {})
+    wrapper = new(body, options)
+
+    wrapper.parse
+  end
+
+  def initialize(body, headers = {})
+    @body, @headers = body, headers
+  end
+
+  def parse
+    wrapper = "Raw"
+
+    if headers.has_key?('content-type')
+      wrapper = content_type_to_class(headers['content-type'])
+    end
+
+    klass = "Facile::Response::Wrapper::#{wrapper}".split('::').inject(Object) do |o, c|
+      o.const_get(c)
+    end
+
+    klass.new(@body).parsed_body
+  end
+
+  def content_type_to_class(content_type)
+    case content_type
+    when /application\/json/
+      'Json'
+    else
+      'Raw'
+    end
+  end
+
+  attr_reader :body, :headers
+end

data/lib/facile/response.rb

@@ -0,0 +1,26 @@
+class Facile::Response
+  autoload :Wrapper, 'facile/response/wrapper'
+
+  def initialize(options)
+    options.each do |k,v|
+      self.send("#{k}=", v)
+    end
+
+    wrap_body(raw_body)
+  end
+
+  def wrap_body(body)
+    @body = ::Facile::Response::Wrapper.parse(body, headers)
+  end
+
+  def method_missing(method, *args, &block)
+    if body.respond_to?(method)
+      body.send(method, args.first)
+    end
+  end
+
+  attr_reader :request, :response, :raw_body, :headers, :status, :body
+
+  protected
+  attr_writer :request, :response, :raw_body, :headers, :status, :body
+end

data/lib/facile/version.rb

@@ -0,0 +1,3 @@
+module Facile
+  VERSION = '0.0.1'
+end

data/lib/facile.rb

@@ -0,0 +1,8 @@
+require 'facile/version'
+
+module Facile
+  autoload :Api, 'facile/api'
+  autoload :Request, 'facile/request'
+  autoload :Response, 'facile/response'
+end
+

data/spec/facile/api_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'faraday'
+
+describe 'test api' do
+  it 'can create an api instance' do
+    api = ::Facile::Api.new
+
+    expect(api).to be_kind_of(::Facile::Api)
+  end
+
+  it 'can find items' do
+    ::Facile::Request.any_instance.stub(:go => ::Facile::Response.new(
+      :status => 200,
+      :headers => {'content-type' => 'application/json'},
+      :raw_body => '{"foo": "bar"}'
+    ))
+
+
+    api = ::Facile::Api.new
+    api.class.url = 'http://foo.com'
+
+    returned_api = api.find('2643743')
+
+    expect(returned_api.foo).to eq('bar')
+  end
+
+  it 'can use class method' do
+    ::Facile::Request.any_instance.stub(:go => ::Facile::Response.new(
+      :status => 200,
+      :headers => {'content-type' => 'application/json'},
+      :raw_body => '{"foo": "bar"}'
+    ))
+
+    ::Facile::Api.url = 'http://foo.com'
+
+    ::Facile::Api.find(123)
+  end
+end

data/spec/facile/request_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'faraday'
+
+describe 'test request' do
+  it 'can be used as a convienence method' do
+    faraday_response = Faraday::Response.new({
+      :method => :get,
+      :response_headers => {'content-type' => 'text/plain'},
+      :body => 'foo',
+      :url => 'http://foo.com'
+    })
+
+    Faraday::Connection.any_instance.stub(:get => faraday_response)
+
+    response = ::Facile::Request.get do |req|
+      req.url = 'http://foo.com'
+    end
+
+    expect(response.body).to eq('foo')
+  end
+
+  it 'can create request instance' do
+    request = ::Facile::Request.new
+
+    expect(request).to be_kind_of(::Facile::Request)
+  end
+
+  it 'can parse a response' do
+    request = ::Facile::Request.new
+
+    faraday_response = Faraday::Response.new({
+      :method => :get,
+      :response_headers => {'content-type' => 'text/plain'},
+      :body => 'foo',
+      :url => 'http://foo.com'
+    })
+
+    response = request.parse_response(faraday_response)
+
+    expect(response).to be_kind_of(::Facile::Response)
+    expect(response.body).to eq('foo')
+  end
+end

data/spec/facile/response_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'json'
+require 'hashie'
+
+describe 'test response' do
+  it 'can create instance' do
+    response = ::Facile::Response.new({
+      :headers => {},
+      :raw_body => 'test'
+    })
+
+    expect(response).to be_kind_of(::Facile::Response)
+  end
+
+  it 'can read attributes' do
+    response = ::Facile::Response.new({
+      :headers => {'Foo' => 'bar'},
+      :raw_body => 'body'
+    })
+
+    expect(response.headers).to eq({'Foo' => 'bar'})
+    expect(response.raw_body).to eq('body')
+  end
+
+  it 'can create wrappers successfully' do
+    body = {'foo' => 'bar'}
+
+    response = ::Facile::Response.new({
+      :headers => {'content-type' => 'application/json'},
+      :raw_body => JSON.generate(body)
+    })
+
+    expect(response.body).to eq(Hashie::Mash.new(body))
+  end
+
+  it 'can proxy methods' do
+    body = {'foo' => 'bar'}
+
+    response = ::Facile::Response.new({
+      :headers => {'content-type' => 'application/json'},
+      :raw_body => JSON.generate(body)
+    })
+
+    expect(response.body.foo).to eq('bar')
+  end
+
+  it 'can mash' do
+    body = {'fooZOMG' => 'bar', 'foo' => 1, 'BAR' => 2, 'BaR' => 3}
+
+    mash = ::Facile::Response::Wrapper::Mash.new(body)
+
+    body.keys.each do |key|
+      expect(mash.has_key?(key.underscore)).to eq(true)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$: << File.expand_path('..', __FILE__)
+$: << File.expand_path('../../lib', __FILE__)
+
+if not defined?(JRUBY_VERSION)
+  require 'pry'
+end
+
+require 'facile'
+
+RSpec.configure do |conf|
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: facile
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Simon Thulbourn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Facile: API simplicity gem'
+email:
+- simon+github@thulbourn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- facile.gemspec
+- lib/facile.rb
+- lib/facile/api.rb
+- lib/facile/request.rb
+- lib/facile/response.rb
+- lib/facile/response/wrapper.rb
+- lib/facile/response/wrapper/json.rb
+- lib/facile/response/wrapper/mash.rb
+- lib/facile/response/wrapper/raw.rb
+- lib/facile/version.rb
+- spec/facile/api_spec.rb
+- spec/facile/request_spec.rb
+- spec/facile/response_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'Facile: API simplicity gem'
+test_files:
+- spec/facile/api_spec.rb
+- spec/facile/request_spec.rb
+- spec/facile/response_spec.rb
+- spec/spec_helper.rb