reviewed 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/reviewed/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Reviewed.com
+
+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,36 @@
+# Reviewed
+
+A Ruby Gem for Accessing the Reviewed.com API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'reviewed'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install reviewed
+
+## Usage
+
+First set your Reviewed.com API key:
+
+    Reviewed.api_key = 'my api key'
+
+Now you should be able to query the service:
+
+    site = Reviewed::Website.find('DCI')
+    puts site.name
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/reviewed/article.rb

@@ -0,0 +1,18 @@
+module Reviewed
+  class Article < Base
+    def find_page(slug)
+      pages.find { |page| page.slug.match(/#{slug}/i) }
+    end
+
+    def attachments(tag=nil)
+      if tag.present?
+        @attributes[:attachments].select do |attachment|
+          attachment_tags = attachment.tags || []
+          attachment_tags.map(&:downcase).include?(tag.downcase)
+        end
+      else
+        @attributes[:attachments]
+      end
+    end
+  end
+end

data/lib/reviewed/author.rb

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

data/lib/reviewed/base.rb

@@ -0,0 +1,56 @@
+module Reviewed
+  class Base
+    attr_accessor :raw_response, :resource_url
+
+    def initialize(attributes={}, raw_response=nil)
+      attributes.symbolize_keys!
+
+      unless attributes[:id].present?
+        raise ResourceError.new("Resource requires an ID")
+      end
+
+      @raw_response = raw_response
+      @attributes = Hashie::Mash.new(attributes)
+    end
+
+    def method_missing(sym, *args, &block)
+      if @attributes.has_key?(sym)
+        @attributes[sym]
+      else
+        super
+      end
+    end
+
+    def self.find(id)
+      Reviewed.verify_key!
+
+      response = Reviewed::Request.get(resource_url(id))
+      new(response.json, response.raw)
+    end
+
+    def self.all
+      where({})
+    end
+
+    def self.where(options={})
+      Reviewed.verify_key!
+
+      response = Reviewed::Request.get(resource_url(nil, options))
+      Collection.new(self, response.json, options)
+    end
+
+    def self.resource_name=(value)
+      @resource_name = value
+    end
+
+    def self.resource_name
+      @resource_name ||= self.name.split('::').last.downcase
+    end
+
+    def self.resource_url(id=nil, options={})
+      url = [Reviewed.base_uri, API_VERSION, resource_name.pluralize, id].compact.join("/")
+      query_string = Util.build_query_string(options)
+      query_string.blank? ? url : "#{url}?#{query_string}"
+    end
+  end
+end

data/lib/reviewed/brand.rb

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

data/lib/reviewed/collection.rb

@@ -0,0 +1,66 @@
+module Reviewed
+  class Collection
+    include Enumerable
+    extend Forwardable
+    def_delegators :@items, :<<, :[], :[]=, :each, :first, :last, :length, :concat, :map, :collect, :empty?
+
+    attr_accessor :raw_response
+
+    def initialize(klass, json, options={})
+      page_data = json[:pagination].symbolize_keys!
+
+      @items = []
+      items = json[:data]
+      items.each do |item|
+        @items << klass.new(item)
+      end
+
+      @page_attributes = page_data
+      @raw_response = json
+      @request_options = options.symbolize_keys!
+      @klass = klass
+    end
+
+    def limit_value
+      per_page
+    end
+
+    def num_pages
+      total_pages
+    end
+
+    def total_count
+      total
+    end
+
+    def next_page
+      return nil if @page_attributes[:last_page]
+      fetch_page(@page_attributes[:next_page])
+    end
+
+    def previous_page
+      return nil if @page_attributes[:first_page]
+      fetch_page(@page_attributes[:previous_page])
+    end
+
+    def ==(other)
+      @raw_response == other.raw_response
+    end
+
+    def method_missing(sym, *args, &block)
+      clean_sym = sym.to_s.gsub(/\?/, '').to_sym
+      if @page_attributes.has_key?(clean_sym)
+        @page_attributes[clean_sym]
+      else
+        super
+      end
+    end
+
+    private
+
+    def fetch_page(page=nil)
+      @request_options[:page] = page
+      @klass.where(@request_options)
+    end
+  end
+end

data/lib/reviewed/product.rb

@@ -0,0 +1,14 @@
+module Reviewed
+  class Product < Base
+    def attachments(tag=nil)
+      if tag.present?
+        @attributes[:attachments].select do |attachment|
+          attachment_tags = attachment.tags || []
+          attachment_tags.map(&:downcase).include?(tag.downcase)
+        end
+      else
+        @attributes[:attachments]
+      end
+    end
+  end
+end

data/lib/reviewed/request.rb

@@ -0,0 +1,23 @@
+module Reviewed
+  class Request
+
+    class << self
+
+      def get(url)
+        url = url =~ /http/ ? url : build_url(url)
+
+        begin
+          raw_response = RestClient.get(url, Util.build_request_headers)
+          Reviewed::Response.new(raw_response)
+        rescue RestClient::Exception => e
+          raise ResourceError.new(e.message)
+        end
+      end
+
+      def build_url(url)
+        url = [Reviewed.base_uri, API_VERSION, url].compact.join("/")
+      end
+    end
+  end
+end
+

data/lib/reviewed/response.rb

@@ -0,0 +1,12 @@
+module Reviewed
+  class Response
+
+    attr_accessor :raw
+    attr_accessor :json
+
+    def initialize(raw_response)
+      @raw = raw_response
+      @json = JSON.parse(raw_response).symbolize_keys!
+    end
+  end
+end

data/lib/reviewed/util.rb

@@ -0,0 +1,16 @@
+module Reviewed
+  class Util
+    def self.build_request_headers(headers={})
+      headers['X-Reviewed-Authorization'] ||= Reviewed.api_key
+      headers['accept'] ||= 'json'
+      headers.stringify_keys!
+    end
+
+    def self.build_query_string(hash={})
+      hash.keys.inject('') do |query_string, key|
+        query_string << '&' unless key == hash.keys.first
+        query_string << "#{URI.encode(key.to_s)}=#{URI.encode(hash[key].to_s)}"
+      end
+    end
+  end
+end

data/lib/reviewed/version.rb

@@ -0,0 +1,4 @@
+module Reviewed
+  VERSION = "0.0.1"
+  API_VERSION = 'v1'
+end

data/lib/reviewed/website.rb

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

data/lib/reviewed.rb

@@ -0,0 +1,52 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_support/core_ext'
+require 'rest_client'
+require 'hashie'
+require 'forwardable'
+
+require 'reviewed/version'
+require 'reviewed/util'
+require 'reviewed/base'
+require 'reviewed/collection'
+require 'reviewed/request'
+require 'reviewed/response'
+
+require 'reviewed/website'
+require 'reviewed/product'
+require 'reviewed/author'
+require 'reviewed/brand'
+require 'reviewed/article'
+
+module Reviewed
+  class ConfigurationError < StandardError; end
+  class ResourceError < StandardError; end
+
+  @@config = {
+    base_uri: 'http://localhost:3000/api'
+  }
+
+  def self.api_key=(token)
+    @@config[:api_key] = token
+  end
+
+  def self.api_key
+    @@config[:api_key]
+  end
+
+  def self.base_uri=(uri)
+    @@config[:base_uri] = uri
+  end
+
+  def self.base_uri
+    @@config[:base_uri]
+  end
+
+  def self.verify_key!
+    if Reviewed.api_key.present?
+      true
+    else
+      raise ConfigurationError.new("Please set Reviewed.api_key before making a request")
+    end
+  end
+end

data/reviewed.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/reviewed/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Plante", "Kevin Incorvia"]
+  gem.email         = ["development@reviewed.com"]
+  gem.description   = %q{Client library for the Reviewed.com API}
+  gem.summary       = %q{A Ruby Gem for Accessing the Reviewed.com API}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "reviewed"
+  gem.require_paths = ["lib"]
+  gem.version       = Reviewed::VERSION
+
+  gem.add_dependency 'activesupport', '>= 3.0'
+  gem.add_dependency 'rest-client', '>= 1.6'
+  gem.add_dependency 'hashie', '~> 1.2'
+
+  gem.add_development_dependency 'rspec', '>= 2.10'
+  gem.add_development_dependency 'webmock', '>= 1.8'
+  gem.add_development_dependency 'vcr', '>= 2.1'
+  gem.add_development_dependency 'guard-rspec', '>= 1.0'
+end

data/spec/article_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Reviewed::Article do
+  describe 'find_page' do
+    use_vcr_cassette 'article/find_page'
+
+    it 'finds a page with a matching slug' do
+      article = Reviewed::Article.find('minden-master-ii-grill-review')
+      article.pages.length.should == 4
+      article.find_page('performance').should == article.pages[1]
+    end
+  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 'returns all attachments' do
+      @article.attachments.length.should > 1
+    end
+
+    it 'finds attachments by tag' do
+      attachments = @article.attachments('hero')
+      attachments.length.should == 1
+      attachments.each do |attachment|
+        attachment.tags.join(',').should match(/hero/i)
+      end
+    end
+  end
+end

data/spec/author_spec.rb

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

data/spec/base_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+module Reviewed
+  class Example < Base
+  end
+end
+
+module Reviewed
+  class Article < Base
+  end
+end
+
+describe Reviewed::Base do
+  before(:each) do
+    Reviewed.api_key = TEST_KEY
+  end
+
+  describe 'initialization' do
+    it 'raises an error if a resource ID is not present' do
+      expect {
+        Reviewed::Example.new
+      }.to raise_error(Reviewed::ResourceError)
+    end
+
+    it 'returns a value' do
+      model = Reviewed::Example.new(id: 1234, name: 'Test')
+      model.id.should == 1234
+    end
+  end
+
+  describe 'find' do
+    before(:each) do
+      Reviewed::Example.resource_name = 'article' # test
+    end
+
+    it 'raises an error if the api key is not set' do
+      Reviewed.api_key = nil
+
+      expect {
+        Reviewed::Example.find('test')
+      }.to raise_error(Reviewed::ConfigurationError)
+    end
+
+    context 'with a valid request' do
+      use_vcr_cassette 'base/find_ok'
+
+      it 'fetches content from the api' do
+        model = Reviewed::Example.find('5036d7dd60de7d2065075752')
+        model.raw_response.should_not be_nil
+      end
+
+      it 'parses response json and returns an object' do
+        model = Reviewed::Example.find('5036d7dd60de7d2065075752')
+        model.class.should == Reviewed::Example
+        model.id.should == '5036d7dd60de7d2065075752'
+        model.name.should == 'Fast Appliances To Save You Time'
+      end
+    end
+
+    context 'with an invalid request' do
+      use_vcr_cassette 'base/find_error_key'
+
+      it 'complains if the api key is unauthorized' do
+        Reviewed.api_key = 'xxxxxxxxxxxxxxxx'
+
+        expect {
+          Reviewed::Example.find('50241b9c5da4ac8d38000001')
+        }.to raise_error(Reviewed::ResourceError, /unauthorized/i)
+      end
+
+      it 'complains if the requested resource is not found' do
+        expect {
+          Reviewed::Example.find('notfound')
+        }.to raise_error(Reviewed::ResourceError, /not found/i)
+      end
+    end
+  end
+
+  describe 'where' do
+    use_vcr_cassette 'base/where_collection'
+
+    it 'returns a collection' do
+      collection = Reviewed::Article.all
+      collection.class.should == Reviewed::Collection
+    end
+
+    it 'returns the appropriate page of results' do
+      collection = Reviewed::Article.where(:page => 2)
+      collection.total.should == 7141
+      collection.current_page.should == 2
+    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
+    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
+    end
+  end
+
+  describe 'attributes' do
+    it 'returns the named attribute (via method missing)' do
+      model = Reviewed::Example.new(:id => 'id', :super_awesome => 'true')
+      model.super_awesome.should == 'true'
+    end
+  end
+
+  describe 'resource url' do
+    it 'returns an individual resource' do
+      Reviewed::Example.resource_url('article-123').should == 'https://the-guide-staging.herokuapp.com/api/v1/articles/article-123'
+    end
+
+    it 'returns a collection of resources' do
+      Reviewed::Example.resource_url(nil).should == 'https://the-guide-staging.herokuapp.com/api/v1/articles'
+    end
+
+    it 'includes a query parameter' do
+      Reviewed::Example.resource_url(nil, page: 2).should == 'https://the-guide-staging.herokuapp.com/api/v1/articles?page=2'
+    end
+  end
+end

data/spec/brand_spec.rb

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

data/spec/collection_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module Reviewed
+  class Product < Base
+  end
+end
+
+describe Reviewed::Collection do
+  use_vcr_cassette 'collection/products'
+
+  before(:each) do
+    Reviewed.api_key = TEST_KEY
+    @collection = Reviewed::Product.all # creates a collection
+  end
+
+  describe 'collection data' do
+    it 'is enumerable' do
+      @collection.each do |product|
+        product.class.should == Reviewed::Product
+        product.id.should_not be_blank
+      end
+    end
+
+    it 'contains the raw response' do
+      @collection.raw_response.should_not be_blank
+    end
+
+    it 'fetches the first page by default' do
+      @collection.current_page.should == 1
+    end
+  end
+
+  describe 'next page' do
+    it 'fetches the next page of results' do
+      page2 = @collection.next_page
+      page2.current_page.should == 2
+    end
+  end
+
+  describe 'previous page' do
+    it 'fetches the previous page of results' do
+      page2 = @collection.next_page
+      page1 = page2.previous_page
+      @collection.should == page1
+      page1.current_page.should == 1
+    end
+
+    it 'returns nil if there is no previous page' do
+      @collection.previous_page.should be_nil
+    end
+  end
+
+  describe 'page attributes (pagination)' do
+    it 'returns the total item count' do
+      @collection.total.should == 15060
+    end
+
+    it 'returns the total number of pages' do
+      @collection.total_pages.should == 753
+    end
+
+    it 'indicates whether this is the first or last page' do
+      @collection.first_page.should be_true
+      @collection.last_page.should be_false
+    end
+
+    it 'indicates if the page number is out of bounds' do
+      @collection.out_of_bounds.should be_false
+    end
+
+    it 'returns the offset' do
+      @collection.offset.should == 0
+    end
+
+    it 'returns the limit value (max per page)' do
+      @collection.per_page.should == 20
+    end
+
+    it 'returns the number of entries on the current page' do
+      @collection.entries_on_page.should == 20
+    end
+  end
+end