facile 0.0.1 → 0.1.0

data/README.md

@@ -23,20 +23,19 @@ Or install it yourself as:
 
 ## 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'
+class Foo
+  include ::Facile::Api
+  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
+foo.forecast_content.forecasts.first.date
 ```
 
 ## Contributing

data/lib/facile/api.rb

@@ -1,55 +1,14 @@
 require 'addressable/template'
-require 'active_support/core_ext/class/attribute_accessors'
+require 'forwardable'
 
-class Facile::Api
-  cattr_accessor :url, :headers, :body, :params, :options
+require 'facile/api/http_methods'
+require 'facile/api/request_methods'
+require 'facile/api/forward_methods'
 
-  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
-    }
+module Facile::Api
+  def self.included(base)
+    base.extend(::Facile::Api::HttpMethods)
+    base.extend(::Facile::Api::RequestMethods)
+    base.extend(::Facile::Api::ForwardMethods)
   end
 end

data/lib/facile/api/forward_methods.rb

@@ -0,0 +1,29 @@
+require 'forwardable'
+
+module Facile::Api
+  module ForwardMethods
+    include Forwardable
+
+    def self.extended(base)
+      base.instance_variable_set(:@response, nil)
+      base.instance_eval { attr_accessor :response }
+    end
+
+    def create_instance(body = nil)
+      class_instance = new
+      class_instance.response = body
+
+      create_delegators(class_instance)
+      class_instance
+    end
+
+    def create_delegators(class_instance)
+      if class_instance.response && class_instance.response.respond_to?(:keys)
+        class_instance.response.keys.each do |key|
+          class_instance.class.def_delegator :@response, key.to_sym
+          class_instance.class.def_delegator :@response, "#{key}=".to_sym
+        end
+      end
+    end
+  end
+end

data/lib/facile/api/http_methods.rb

@@ -0,0 +1,44 @@
+module Facile::Api
+  module HttpMethods
+    def self.extended(base)
+      base.instance_variable_set(:@defaults, {})
+    end
+
+    def url(url = nil)
+      return defaults[:url] if url.nil?
+
+      defaults[:url] = url
+    end
+
+    def body(body = nil)
+      return defaults[:body] if body.nil?
+
+      defaults[:body] = body
+    end
+
+    def headers(headers = nil)
+      return defaults[:headers] if headers.nil?
+
+      defaults[:headers] = headers
+    end
+
+    def params(params = nil)
+      return defaults[:params] if params.nil?
+
+      defaults[:params] = params
+    end
+
+    def options(options = nil)
+      return defaults[:options] if options.nil?
+
+      defaults[:options] = options
+    end
+
+
+    protected
+
+    def defaults
+      @defaults
+    end
+  end
+end

data/lib/facile/api/request_methods.rb

@@ -0,0 +1,42 @@
+require 'forwardable'
+
+module Facile::Api
+  module RequestMethods
+    include Forwardable
+
+    def find(*args)
+      id, options = args[0] || nil, args[1] || {}
+
+      url = generate_url(id, self.url)
+      req_options = request_options(url)
+
+      body = create_request(req_options).body
+
+      create_instance(body)
+    end
+
+    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.headers || {},
+        :options => self.options || {},
+        :body => self.body,
+        :params => self.params || {}
+      }
+    end
+  end
+end

data/lib/facile/version.rb

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

data/spec/facile/api_spec.rb

@@ -1,38 +1,135 @@
 require 'spec_helper'
+require 'hashie'
 require 'faraday'
 
-describe 'test api' do
-  it 'can create an api instance' do
-    api = ::Facile::Api.new
+describe Facile::Api::HttpMethods do
+  before do
+    class TestClass
+      include ::Facile::Api
+      url 'http://bbc.co.uk'
+    end
+  end
+
+  context 'able to set values' do
+    it 'http methods work' do
+      # there's no real need to test this any further
+      expect(TestClass.url).to eq('http://bbc.co.uk')
+    end
+  end
+
+  context 'does not share state' do
+    it 'other classes using the same method have different values' do
+      class Zomg
+        include ::Facile::Api
+      end
+
+      expect(TestClass.url).to eq('http://bbc.co.uk')
+      expect(Zomg.url).to eq(nil)
+    end
+  end
+end
 
-    expect(api).to be_kind_of(::Facile::Api)
+describe Facile::Api::RequestMethods do
+  before do
+    class TestClass
+      include ::Facile::Api
+
+      url 'http://bbc.co.uk'
+    end
   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"}'
-    ))
+  context 'request options' do
+    it 'can be generated' do
+      expected = {
+        :url => 'http://bbc.co.uk',
+        :method => :get,
+        :headers => {},
+        :params => {},
+        :body => nil,
+        :options => {}
+      }
+
+      expect(TestClass.request_options(TestClass.url)).to eq(expected)
+    end
+  end
 
+  context 'generate url' do
+    it 'can insert placeholder' do
+      class OtherTestClass
+        include ::Facile::Api
 
-    api = ::Facile::Api.new
-    api.class.url = 'http://foo.com'
+        url 'http://bbc.co.uk/{id}'
+      end
 
-    returned_api = api.find('2643743')
+      generated_url = OtherTestClass.generate_url(1, OtherTestClass.url)
 
-    expect(returned_api.foo).to eq('bar')
+      expect(generated_url).to eq('http://bbc.co.uk/1')
+    end
   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"}'
-    ))
+  context 'request things' do
+    it 'can request things' do
+      faraday_response = Faraday::Response.new({
+        :method => :get,
+        :response_headers => {'content-type' => 'text/plain'},
+        :body => 'foo',
+        :url => 'http://bbc.com'
+      })
+
+      Faraday::Connection.any_instance.stub(:get => faraday_response)
+
+      inst = TestClass.find()
+
+      expect(inst).to be_kind_of(TestClass)
+      expect(inst.response).to eq('foo')
+    end
+  end
+end
+
+describe Facile::Api::ForwardMethods do
+  before do
+    class TestClass
+      include ::Facile::Api
+    end
+  end
+
+  context 'can create instance' do
+    it 'create instance of test class' do
+      inst = TestClass.create_instance
+
+      expect(inst).to be_kind_of(TestClass)
+    end
+
+    it 'can create instance with string data' do
+      inst = TestClass.create_instance('test')
+
+      expect(inst.response).to eq('test')
+    end
+
+    it 'can create instance with hash' do
+      hash = Hashie::Mash.new({:foo => 'bar'})
+      inst = TestClass.create_instance(hash)
+
+      expect(inst.response).to eq(hash)
+    end
+  end
+
+  context 'can delegate methods' do
+    it 'can read from a method' do
+      hash = Hashie::Mash.new({:foo => 'bar'})
+      inst = TestClass.create_instance(hash)
+
+      expect(inst.foo).to eq('bar')
+    end
+
+    it 'can write from a method' do
+      hash = Hashie::Mash.new({:foo => 'bar'})
+      inst = TestClass.create_instance(hash)
 
-    ::Facile::Api.url = 'http://foo.com'
+      expect(inst.foo).to eq('bar')
 
-    ::Facile::Api.find(123)
+      inst.foo = 'zomg'
+      expect(inst.foo).to eq('zomg')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facile
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-27 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,9 @@ files:
 - facile.gemspec
 - lib/facile.rb
 - lib/facile/api.rb
+- lib/facile/api/forward_methods.rb
+- lib/facile/api/http_methods.rb
+- lib/facile/api/request_methods.rb
 - lib/facile/request.rb
 - lib/facile/response.rb
 - lib/facile/response/wrapper.rb