reviewed 0.1.2 → 0.1.4

data/README.md

@@ -18,14 +18,21 @@ Or install it yourself as:
 
 ## Usage
 
-First set your Reviewed.com API key:
+Create a client to use in your application and configure as needed:
 
-    Reviewed.api_key = 'my api key'
+    client = Reviewed::Client.new(
+      api_key: '0A0A1010202030',                    # required
+      base_uri: 'http://www.example.com/api/v1',    # defaults to localhost:3000
+      request_params: { per_page: 1 }               # query params applied to every request
+    )
 
-Now you should be able to query the service:
+Make a request via resources on your client:
 
-    site = Reviewed::Website.find('DCI')
-    puts site.name
+    client.articles.all
+    client.articles.find('123456')
+
+    client.products.all
+    client.products.find('123456')
 
 ## Contributing
 

data/lib/faraday/api_key.rb

@@ -0,0 +1,14 @@
+module Faraday
+  class ApiKey < Faraday::Middleware
+
+    def call(env)
+      unless env[:request_headers]['X-Reviewed-Authorization']
+        raise ::Reviewed::ConfigurationError.new(msg: "Please set the API key for your Reviewed::Client instance before making a request")
+      end
+
+      @app.call(env)
+    end
+  end
+end
+
+Faraday.register_middleware :request, api_key: Faraday::ApiKey

data/lib/faraday/errors.rb

@@ -0,0 +1,14 @@
+module Faraday
+  class Errors < Faraday::Middleware
+
+    def call(env)
+      @app.call(env).on_complete do
+        if env[:response].status == 404
+          raise Reviewed::ResourceNotFound.new(msg: 'Not Found', url: env[:url])
+        end
+      end
+    end
+  end
+end
+
+Faraday.register_middleware :response, errors: Faraday::Errors

data/lib/reviewed/article.rb

@@ -13,7 +13,9 @@ module Reviewed
     end
 
     def primary_product
-      products.select { |p| p.id == primary_product_id }.first
+      if respond_to?(:products)
+        products.select { |p| p.id == primary_product_id }.first
+      end
     end
 
     def attachments(tag=nil)

data/lib/reviewed/award.rb

@@ -0,0 +1,4 @@
+module Reviewed
+  class Award < Base
+  end
+end

data/lib/reviewed/base.rb

@@ -3,7 +3,6 @@ require 'active_model'
 module Reviewed
   class Base
     include ::Reviewed::Embeddable
-    include ::Reviewed::Utils
 
     extend ::ActiveModel::Naming
 
@@ -13,25 +12,38 @@ module Reviewed
       self.attributes = objectify(data)
     end
 
-    class << self
-
-      def find(id, params={})
-        object_from_response(:get, "#{resource_url}/#{id}", params)
+    def created_at
+      if @attributes.has_key?(:created_at)
+        Time.parse(@attributes[:created_at])
+      else
+        nil
       end
+    end
 
-      def where(params={})
-        collection_from_response(:get, resource_url, params)
+    def updated_at
+      if @attributes.has_key?(:updated_at)
+        Time.parse(@attributes[:updated_at])
+      else
+        nil
       end
+    end
+
+    class << self
 
-      def all
-        where({})
+      def path
+        @resource_name ||= association_name
       end
 
-      def resource_url
-        @resource_name ||= self.name.demodulize.downcase.pluralize
+      def association_name
+        self.name.demodulize.downcase.pluralize
       end
     end
 
+    def respond_to?(sym, include_private=false)
+      return true if super
+      @attributes.has_key?(sym)
+    end
+
     def method_missing(sym, *args, &block)
       if @attributes.has_key?(sym)
         @attributes[sym]

data/lib/reviewed/client.rb

@@ -1,57 +1,78 @@
 module Reviewed
   class Client
-    include ::Reviewed::Configurable
+    attr_accessor :api_key, :base_uri, :api_version, :request_params
 
-    attr_accessor :api_key, :base_uri, :api_version
+    BASE_URI = "http://localhost:3000/api/v1"
 
-    def initialize
-      Reviewed::Configurable.options.each do |key, value|
-        instance_variable_set(:"@#{key}", value)
-      end
+    def initialize(opts={})
+      @api_key = opts[:api_key] || ENV['REVIEWED_API_KEY']
+      @base_uri = opts[:base_uri] || BASE_URI
+      @request_params = opts[:request_params] || {}
     end
 
-    # Perform an HTTP DELETE request
-    def delete(path, params={})
-      request(:delete, path, params)
+    def configure
+      yield self
+      self
     end
 
     # Perform an HTTP GET request
     def get(path, params={})
-      request(:get, path, params)
-    end
-
-    # Perform an HTTP POST request
-    def post(path, params={})
-      request(:post, path, params)
+      perform(:get, path, params)
     end
 
     # Perform an HTTP PUT request
     def put(path, params={})
-      request(:put, path, params)
+      perform(:put, path, params)
     end
 
-    def url
-      [base_uri, api_version].join('/')
+    # Perform an HTTP DELETE request
+    def post(path, params={})
+      perform(:post, path, params)
     end
 
-    private
+    # Perform an HTTP DELETE request
+    def delete(path, params={})
+      perform(:delete, path, params)
+    end
 
-    def request(method, path, params={})
-      verify_key!
+    def resource(name)
+      klass_string = "Reviewed::#{name.to_s.singularize.classify}"
+      klass_string.constantize rescue name
+    end
 
-      connection.send(method.to_sym, path, params) do |request|
-        request.headers['X-Reviewed-Authorization'] ||= Reviewed.api_key
-      end
+    def method_missing(method, *args, &block)
+      Reviewed::Request.new(resource: resource(method), client: self)
     end
 
     def connection
-      @connection ||= ::Faraday.new(url: url) do |faraday|
+      @connection ||= ::Faraday.new(url: base_uri) do |faraday|
         faraday.response :mashify
+        faraday.response :errors
         faraday.response :json
-        faraday.request  :global_params
+        faraday.request  :api_key
         faraday.request  :url_encoded
         faraday.adapter  Faraday.default_adapter
       end
     end
+
+    private
+
+    def perform(method, path, params={})
+      begin
+        self.connection.send(method.to_sym, path, params) do |request|
+          request.params.merge!(self.request_params)
+          request.headers['X-Reviewed-Authorization'] ||= self.api_key
+        end
+      rescue Faraday::Error::ClientError => e
+        message = <<-EOS.gsub(/^[ ]*/, '')
+          API Error. method: #{method}. path: #{path}. params: #{params.to_s}. api_key: #{self.api_key}
+          Original exception message:
+          #{e.message}
+        EOS
+        new_exception = Reviewed::ApiError.new(msg: message)
+        new_exception.set_backtrace(e.backtrace) # TODO not seeing in Airbrake
+        raise new_exception
+      end
+    end
   end
 end

data/lib/reviewed/collection.rb

@@ -1,22 +1,22 @@
 module Reviewed
   class Collection
-    include Reviewed::Utils
     include Enumerable
 
     extend Forwardable
 
     def_delegators :@items, :<<, :[], :[]=, :each, :first, :last, :length, :concat, :map, :collect, :empty?
 
-    attr_accessor :raw_response, :page_attributes, :klass, :items, :params
+    attr_accessor :raw_response, :page_attributes, :klass, :items, :params, :client
 
-    def initialize(klass, response, params={})
+    def initialize(client, klass, response, params={})
       body = response.body
       data = body.data
 
-      self.page_attributes = body.pagination
-      self.params = params
-      self.klass = klass
-      self.items = []
+      @client = client
+      @klass = klass
+      @params = params
+      @items = []
+      @page_attributes = body.pagination
 
       data.each do |obj|
         self.items << klass.new(obj)
@@ -58,7 +58,7 @@ module Reviewed
 
     def fetch_page(page=nil)
       self.params[:page] = page
-      @klass.where(self.params)
+      client.send(klass.association_name).where(self.params)
     end
   end
 end

data/lib/reviewed/product.rb

@@ -4,6 +4,8 @@ module Reviewed
   class Product < Base
     has_many :attachments
     has_many :manufacturer_specs
+    has_many :awards
+    has_one  :brand
 
     def attachments(tag=nil)
       if tag.present?

data/lib/reviewed/request.rb

@@ -0,0 +1,43 @@
+module Reviewed
+  class Request
+    attr_accessor :client, :resource
+    attr_reader :path
+
+    def initialize(opts={})
+      if opts[:resource].kind_of?(Class)
+        @resource = opts[:resource]
+        @path = @resource.path
+      else
+        @path = opts[:resource].to_s
+      end
+
+      @client = opts[:client] || Reviewed::Client.new
+    end
+
+    # Get request on resource#show
+    def find(id, params={})
+      url_path = [path, CGI::escape(id.to_s)]
+      object_from_response(:get, url_path.join('/'), params)
+    end
+
+    # Get request on resource#index with query params
+    def where(params={})
+      collection_from_response(:get, path, params)
+    end
+
+    # Convenience Method
+    def all
+      where({})
+    end
+
+    def object_from_response(method, url, params={})
+      response = client.send(method, url, params)
+      resource.new(response.body)
+    end
+
+    def collection_from_response(method, url, params={})
+      response = client.send(method, url, params)
+      Reviewed::Collection.new(client, resource, response, params)
+    end
+  end
+end

data/lib/reviewed/version.rb

@@ -1,4 +1,4 @@
 module Reviewed
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
   API_VERSION = 'v1'
 end

data/lib/reviewed.rb

@@ -2,48 +2,41 @@ $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
 
 require 'faraday'
 require 'faraday_middleware'
-require 'faraday/global_params'
+require 'faraday/api_key'
+require 'faraday/errors'
 require 'active_support/inflector'
 require 'active_support/core_ext'
 require 'active_model'
 require 'hashie'
 require 'rack'
 
-require 'reviewed/configurable'
 require 'reviewed/embeddable'
-require 'reviewed/utils'
+require 'reviewed/request'
 require 'reviewed/client'
 require 'reviewed/collection'
 require 'reviewed/base'
 
 require 'reviewed/manufacturer_spec'
+require 'reviewed/award'
+require 'reviewed/brand'
 require 'reviewed/product'
 require 'reviewed/article'
 require 'reviewed/author'
-require 'reviewed/brand'
 require 'reviewed/page'
 require 'reviewed/website'
 
 
 module Reviewed
-  class ConfigurationError < StandardError; end
-
-  class << self
-
-    attr_accessor :global_params
-
-    def global_params
-      @global_params ||= {}
-    end
-
-    def client
-      @client ||= Reviewed::Client.new
-    end
+  class BaseError < StandardError
+    attr_accessor :url
 
-    def method_missing(method, *args, &block)
-      return super unless client.respond_to?(method)
-      client.send(method, *args, &block)
+    def initialize(opts={})
+      @url = opts[:url]
+      super(opts[:msg])
     end
   end
+  class ConfigurationError < Reviewed::BaseError; end
+  class ResourceNotFound < Reviewed::BaseError; end
+  class ApiError < Reviewed::BaseError; end
 end
 

data/reviewed.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'hashie', '~> 1.2'
   gem.add_dependency 'rack'
 
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '>= 2.10'
   gem.add_development_dependency 'webmock', '>= 1.8'
   gem.add_development_dependency 'vcr', '>= 2.1'

data/spec/article_spec.rb

@@ -1,11 +1,18 @@
 require 'spec_helper'
 
-describe Reviewed::Article do
+describe Reviewed::Article, vcr: true do
 
-  describe 'associations' do
+  let(:client) do
+    Reviewed::Client.new(api_key: TEST_KEY, base_uri: TEST_URL)
+  end
+
+  before(:each) do
+    @article = client.articles.find('big-green-egg-medium-charcoal-grill-review', { with_attachments: true })
+  end
+
+  describe 'associations', vcr: true do
 
     describe 'pages' do
-      use_vcr_cassette 'article/pages'
 
       it 'has_many :pages' do
         Reviewed::Article._embedded_many.should include({"pages"=>Reviewed::Page})
@@ -13,11 +20,6 @@ describe Reviewed::Article do
     end
 
     describe 'products' do
-      use_vcr_cassette 'article/products'
-
-      before(:each) do
-        @article = Reviewed::Article.find('big-green-egg-medium-charcoal-grill-review')
-      end
 
       it 'has_many :products' do
         Reviewed::Article._embedded_many.should include({"products"=>Reviewed::Product})
@@ -31,11 +33,6 @@ describe Reviewed::Article do
     end
 
     describe 'attachments' do
-      use_vcr_cassette 'article/attachments'
-
-      before(:each) do
-        @article = Reviewed::Article.find('big-green-egg-medium-charcoal-grill-review')
-      end
 
       it 'has_many :attachments' do
         Reviewed::Article._embedded_many.should include({"attachments"=>Reviewed::Attachment})
@@ -52,7 +49,7 @@ describe Reviewed::Article do
       end
 
       it 'finds attachments by tag' do
-        attachments = @article.attachments('hero')
+        attachments = @article.attachments('old-hero')
         attachments.length.should == 1
         attachments.each do |attachment|
           attachment.tags.join(',').should match(/hero/i)
@@ -66,12 +63,11 @@ describe Reviewed::Article do
     end
   end
 
-  describe 'find_page' do
-    use_vcr_cassette 'article/find_page'
+  describe 'find_page', vcr: true do
 
     it 'finds a page with a matching slug' do
-      article = Reviewed::Article.find('minden-master-ii-grill-review')
-      article.pages.length.should == 9
+      article = client.articles.find('minden-master-ii-grill-review')
+      article.pages.length.should == 4
       page = article.find_page('performance')
       page.should == article.pages[2]
       page.name.should == 'Performance'
@@ -79,11 +75,10 @@ describe Reviewed::Article do
   end
 
 
-  describe 'primary_product' do
-    use_vcr_cassette 'article/products'
+  describe 'primary_product', vcr: true do
 
     before(:each) do
-      @article = Reviewed::Article.find('big-green-egg-medium-charcoal-grill-review')
+      @article = client.articles.find('big-green-egg-medium-charcoal-grill-review')
       @product = @article.primary_product
     end
 
@@ -94,5 +89,10 @@ describe Reviewed::Article do
     it "returns a product of the correct class" do
       @product.class.should == Reviewed::Product
     end
+
+    it 'returns nil if does not respond to products' do
+      @article.attributes.delete(:products)
+      @article.primary_product.should be_nil
+    end
   end
 end

data/spec/award_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Reviewed::Award do
+end

data/spec/base_spec.rb

@@ -26,76 +26,50 @@ describe Reviewed::Base do
     end
   end
 
-  describe 'find' do
-    use_vcr_cassette 'base/article/find'
+  describe 'path' do
 
-    it 'returns an article' do
-      Reviewed::Article.find("#{article_id}").should be_an_instance_of(Reviewed::Article)
-    end
-
-    it 'calls object_from_response with correct params' do
-      Reviewed::Article.should_receive(:object_from_response).with(
-        :get, "articles/#{article_id}", {}
-      )
-      Reviewed::Article.find("#{article_id}")
+    it 'should the demodulized resource name' do
+      Reviewed::Article.path.should eql("articles")
     end
   end
 
-  describe 'resource_url' do
+  describe 'association_name' do
 
-    it 'should the demodulized resource name' do
-      Reviewed::Article.resource_url.should eql("articles")
+    it 'returns the demodulized & pluralized version of itself' do
+      Reviewed::Article.association_name.should eql("articles")
     end
   end
 
-  describe 'where' do
-    use_vcr_cassette 'base/where_collection'
-
-    it 'returns a collection' do
-      collection = Reviewed::Article.where
-      collection.class.should == Reviewed::Collection
+  describe 'attributes' do
+    before(:each) do
+      @timestamp = Time.parse("01/01/2013 10:00:00 GMT")
+      @model = Example.new(id: 'id', super_awesome: 'true', created_at: @timestamp.to_s, updated_at: @timestamp.to_s)
     end
 
-    it 'returns the appropriate page of results' do
-      collection = Reviewed::Article.where(:page => 2)
-      collection.total.should > 1
-      collection.current_page.should == 2
+    it 'returns the named attribute (via method missing)' do
+      @model.super_awesome.should == 'true'
     end
 
-    it 'filters collections using other supported options' do
-      collection = Reviewed::Article.where(:keywords => 'minden')
-      collection.total.should == 1
-      collection.last_page.should be_true
+    it 'has a created at timestamp' do
+      @model.created_at.should == @timestamp
     end
 
-    it 'returns an empty set if no matching data was found' do
-      collection = Reviewed::Article.where(:keywords => 'doesnotcompute')
-      collection.should be_empty
-      collection.total.should == 0
-      collection.out_of_bounds.should be_true
+    it 'has an updated at timestamp' do
+      @model.updated_at.should == @timestamp
     end
   end
 
-  describe 'all' do
-
-    it 'calls where with empty params' do
-      Reviewed::Article.should_receive(:where).with({})
-      Reviewed::Article.all
+  describe 'respond_to?' do
+    before(:each) do
+      @model = Example.new(id: 'id', super_awesome: 'true')
     end
-  end
 
-  describe 'attributes' do
-    it 'returns the named attribute (via method missing)' do
-      model = Example.new(:id => 'id', :super_awesome => 'true')
-      model.super_awesome.should == 'true'
+    it 'takes attributes into consideration' do
+      @model.respond_to?(:super_awesome).should be_true
     end
-  end
-
-  describe 'resource_url' do
 
-    it 'returns the pluralized demodulized class name' do
-      Reviewed::Article.resource_url.should eql('articles')
-      Example.resource_url.should eql('examples')
+    it 'preserves the original behavior' do
+      @model.respond_to?(:fafafa).should be_false
     end
   end
 end