supportify_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efaa4dbf90422f66f174e05665bddae16f84e315
+  data.tar.gz: cf4eb97233c0020c3d44c23e3e58045b6fc12f51
+SHA512:
+  metadata.gz: fcd6a703366e417b15e2615d8899b711d3059fec2f4f9ae69ca6029aac5aa49d690734a5f94954b87c962ddc54a4e6095470b753a4b4f60a740c0b621c4c11eb
+  data.tar.gz: 35b04959f514c860a4265595e25ed39e2f363c02f98770ba5cbbb9566cf46c8edae8fda4b79d4c3c3ba3f279b0eff09da83e021215385be2df2e90b9e4a52c8c

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,21 @@
+source "http://rubygems.org"
+
+gem 'rest-client', '~> 1.7.1'
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+
+  gem "pry"
+  gem "pry-byebug"
+end
+
+group :test do
+  gem "webmock"
+  gem "factory_girl"
+  gem "faker"
+end

data/Gemfile.lock

@@ -0,0 +1,121 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    debugger-linecache (1.2.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.1.3)
+    docile (1.1.5)
+    factory_girl (4.4.0)
+      activesupport (>= 3.0.0)
+    faker (1.4.3)
+      i18n (~> 0.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.1)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.0)
+    highline (1.6.21)
+    i18n (0.6.11)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    method_source (0.8.2)
+    mime-types (2.3)
+    mini_portile (0.6.0)
+    minitest (5.4.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    netrc (0.7.7)
+    nokogiri (1.6.3.1)
+      mini_portile (= 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    safe_yaml (1.0.3)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  factory_girl
+  faker
+  jeweler (~> 2.0.1)
+  pry
+  pry-byebug
+  rdoc (~> 3.12)
+  rest-client (~> 1.7.1)
+  rspec (~> 2.8.0)
+  simplecov
+  webmock
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Jordan Yaker
+
+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.rdoc

@@ -0,0 +1,19 @@
+= supportify_ruby
+
+Ruby library for Supportify.io.
+
+== Contributing to supportify_ruby
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Supportify, Inc. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "supportify_client"
+  gem.homepage = "http://github.com/supportify/supportify_ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby client for the Supportify.io help and support API.}
+  gem.description = %Q{Ruby client for the Supportify.io help and support API.}
+  gem.email = "jordan.yaker@supportify.io"
+  gem.authors = ["Jordan Yaker", "Supportify, Inc."]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/supportify_client/api/category.rb

@@ -0,0 +1,17 @@
+module Supportify
+  module Api
+    class Category
+      attr_accessor :id, :name, :description
+
+      def self.resource_name
+        'categories'
+      end
+
+      def initialize(attributes = {})
+        self.id = attributes['id']
+        self.name = attributes['name']
+        self.description = attributes['description']
+      end
+    end
+  end
+end

data/lib/supportify_client/api/error.rb

@@ -0,0 +1,13 @@
+module Supportify
+  module Api
+    class Error < ::RuntimeError
+      attr_accessor :code, :short_description, :long_description
+
+      def initialize(attributes = {})
+        self.code = attributes['code']
+        self.short_description = attributes['short_description']
+        self.long_description = attributes['long_description']
+      end
+    end
+  end
+end

data/lib/supportify_client/api/faq.rb

@@ -0,0 +1,23 @@
+module Supportify
+  module Api
+    class Faq
+      attr_accessor :id, :question, :answer, :votes, :rating,
+                    :categories, :tags
+
+      def self.resource_name
+        'faqs'
+      end
+
+      def initialize(attributes = {})
+        self.id = attributes['id']
+        self.question = attributes['question']
+        self.answer = attributes['answer']
+        self.rating = attributes['rating']
+        self.votes = attributes['votes']
+
+        self.categories = (attributes['categories'] || []).map { |c| Category.new c }
+        self.tags = (attributes['tags'] || []).map { |t| Tag.new t }
+      end
+    end
+  end
+end

data/lib/supportify_client/api/tag.rb

@@ -0,0 +1,17 @@
+module Supportify
+  module Api
+    class Tag
+      attr_accessor :id, :name, :description
+
+      def self.resource_name
+        'tags'
+      end
+
+      def initialize(attributes = {})
+        self.id = attributes['id']
+        self.name = attributes['name']
+        self.description = attributes['description']
+      end
+    end
+  end
+end

data/lib/supportify_client/api.rb

@@ -0,0 +1,4 @@
+require 'supportify_client/api/category'
+require 'supportify_client/api/error'
+require 'supportify_client/api/faq'
+require 'supportify_client/api/tag'

data/lib/supportify_client/client.rb

@@ -0,0 +1,49 @@
+require 'supportify_client/api'
+require 'supportify_client/factory'
+require 'supportify_client/gateway'
+require 'supportify_client/repository'
+
+module Supportify
+  class Client
+    class << self
+      def base_url
+        "https://api.supportify.io"
+      end
+
+      def versions
+        %w{v1}
+      end
+
+      def headers
+        {
+          user_agent: "supportify-ruby-gem/#{Supportify::VERSION}",
+          content_type: :json, 
+          accept: :json 
+        }
+      end
+    end
+
+    include Gateway
+    include Repository
+    include Factory
+
+    def initialize(args = {})
+      @config = args
+
+      @config[:api_key] ||= ENV["SUPPORTIFY_API_KEY"]
+      @config[:app_key] ||= ENV["SUPPORTIFY_APP_KEY"]
+      @config[:version] ||= self.class.versions.last
+    end
+
+    protected
+
+    def headers
+      self.class.headers.merge 'X-Supportify-ApiKey' => @config[:api_key],
+                               'X-Supportify-AppKey' => @config[:app_key]
+    end
+
+    def base_url
+      "#{self.class.base_url}/#{@config[:version]}"
+    end   
+  end
+end

data/lib/supportify_client/factory.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Supportify
+  module Factory
+    def parse(body)
+      attributes = JSON.parse(body)
+      key = attributes.keys.first
+
+      klass = case key
+              when /^faq(s?)/i then Supportify::Api::Faq                
+              when /^categor(ies|y)/i then Supportify::Api::Category
+              when /^tag(s?)/i then Supportify::Api::Tag
+              else Supportify::Api::Error
+              end
+
+      unless klass.nil?
+        if attributes[key].is_a? Array or attributes[key].is_a? Hash
+          attributes = attributes[key] 
+        end
+
+        if attributes.is_a? Array
+          attributes.map { |a| klass.new a }
+        else
+          klass.new attributes
+        end
+      end
+    end
+  end
+end

data/lib/supportify_client/gateway.rb

@@ -0,0 +1,33 @@
+require 'pry'
+module Supportify
+  module Gateway 
+    def get(klass, options)
+      request :get, klass, options
+    end
+
+    def post(klass, options)
+      request :post, klass, options
+    end 
+
+    def request(method, klass, options)
+      params = options.extract_options!
+      id = options.pop if options.any?
+
+      url = "#{self.base_url}/#{klass.resource_name}"
+      url << "/#{id}" unless id.nil?
+
+      RestClient::Request.execute method: method, url: url, payload: params, headers: self.headers do |response, request, result|
+        case response.code
+        when 404
+          nil
+        when 200
+          parse response unless response.nil? or response =~ /\A[[:space:]]*\z/
+        when 400, 401, 404, 500
+          raise parse(response)
+        else
+          response.return!(request, result)
+        end
+      end
+    end
+  end  
+end

data/lib/supportify_client/repository.rb

@@ -0,0 +1,19 @@
+module Supportify
+  module Repository
+    def categories(*args)
+      get Supportify::Api::Category, args
+    end
+
+    def faqs(*args)
+      get Supportify::Api::Faq, args
+    end
+
+    def tags(*args)
+      get Supportify::Api::Tag, args
+    end
+
+    def vote(*args)
+      post Supportify::Api::Faq, args
+    end
+  end
+end

data/lib/supportify_client/version.rb

@@ -0,0 +1,3 @@
+module Supportify
+  VERSION = File.read File.expand_path('../../../VERSION', __FILE__)
+end

data/lib/supportify_client.rb

@@ -0,0 +1,18 @@
+require 'rest_client'
+
+require 'supportify_client/client'
+require 'supportify_client/version'
+
+module RestClient::AbstractResponse
+  def success?
+    (200..207).include? code
+  end
+end
+
+if !defined?(ActiveSupport) or ActiveSupport::VERSION::MAJOR < 3
+  Array.class_eval do
+    def extract_options!
+      last.is_a?(::Hash) ? pop : {}
+    end 
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,34 @@
+require 'faker'
+
+FactoryGirl.define do
+  factory :tag, class: Hash do
+    id { rand(100000) }
+    name { Faker::Lorem.word }
+    description { Faker::Lorem.paragraph }
+
+    initialize_with { attributes }
+  end
+
+  factory :category, class: Hash do
+    id { rand(100000) }
+    name { Faker::Lorem.word }
+    description { Faker::Lorem.paragraph }
+
+    initialize_with { attributes }
+  end
+
+  factory :faq, class: Hash do
+    id { rand(100000) }
+    question { Faker::Lorem.sentence }
+    answer { Faker::Lorem.paragraph }
+    votes { rand(100) }
+    rating { rand }
+
+    initialize_with { attributes }
+  end
+
+  factory :faq_with_categories_and_tags, parent: :faq do
+    tags { build_list :tag, rand(1..5) }
+    categories { build_list :category, rand(1..5) }
+  end
+end

data/spec/features/categories_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Category Retrieval" do
+  let(:api_key) { 'api_key' }
+  let(:app_key) { 'app_key' }
+  let(:version) { 'v1' }
+
+  subject do 
+    Supportify::Client.new api_key: api_key,
+                           app_key: app_key,
+                           version: version
+  end
+
+  describe "When retrieving multiple Categories" do
+    let(:categories) { build_list :category, rand(1..5) } 
+    let(:response) { subject.categories }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/categories")
+        .to_return(status: 200, body: { 'categories' => categories }.to_json, headers: {})
+    end
+
+    it { response.should be_a Array }
+    it { response.each { |r| r.should be_a Supportify::Api::Category } }
+  end
+
+  describe "When retrieving a single Category" do
+    let(:category) { build :category } 
+    let(:response) { subject.categories(1) }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/categories/1")
+        .to_return(status: 200, body: { 'category' => category }.to_json, headers: {})
+    end
+
+    it { response.should be_a(Supportify::Api::Category) }
+  end
+
+  describe "When passing in additional arguments" do
+    let(:fields) { 'id,name' } 
+    let(:sort) { 'name-asc' } 
+
+    before do
+      stub_request(:get, "https://api.supportify.io/v1/categories").
+        to_return(:status => 200, :body => "", :headers => {})
+
+      subject.categories fields: fields, sort: sort
+    end
+
+    it "should have passed along the arguments" do
+      WebMock.should have_requested(:get, "https://api.supportify.io/v1/categories")
+        .with(body: { fields: fields, sort: sort })
+    end
+  end
+end

data/spec/features/client_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Supportify::Client do
+  let(:api_key) { 'api_key' }
+  let(:app_key) { 'app_key' }
+  let(:version) { 'v1' }
+
+  subject do 
+    Supportify::Client.new api_key: api_key,
+                           app_key: app_key,
+                           version: version
+  end
+
+  it { Supportify::Client.base_url.should == 'https://api.supportify.io' }
+  it { Supportify::Client.versions.should include('v1') }
+  it { Supportify::Client.headers[:user_agent].should == "supportify-ruby-gem/#{Supportify::VERSION}" }
+  it { Supportify::Client.headers[:content_type].should == :json }
+  it { Supportify::Client.headers[:accept].should == :json }
+
+  describe "when initializing without variables" do
+    let(:target) { Supportify::Client.new }
+    let(:config) { target.instance_variable_get(:@config) }
+
+    before do
+      ENV["SUPPORTIFY_API_KEY"] = api_key
+      ENV["SUPPORTIFY_APP_KEY"] = app_key
+    end
+
+    it { config[:api_key].should == api_key }
+    it { config[:app_key].should == app_key }
+  end
+
+  describe "when making a request" do
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs")
+        .to_return(:status => 200, :body => "", :headers => {})
+
+      subject.faqs
+    end
+
+    it "should have passed in the proper headers" do
+      WebMock.should have_requested(:get, "https://api.supportify.io/v1/faqs")
+      .with(headers: {
+          'X-Supportify-ApiKey' => api_key,
+          'X-Supportify-AppKey' => app_key,
+          'User-Agent' => "supportify-ruby-gem/#{Supportify::VERSION}"
+        })
+    end
+  end
+end

data/spec/features/errors_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Error Handling" do
+  let(:api_key) { 'api_key' }
+  let(:app_key) { 'app_key' }
+  let(:version) { 'v1' }
+  
+  subject do 
+    Supportify::Client.new api_key: api_key,
+                           app_key: app_key,
+                           version: version
+  end
+
+  describe "500" do
+    let(:code) { 500 }
+    let(:short_description) { 'UnexpectedError' }
+    let(:long_description) { "An unexpected error has occurred.  Please try again. If the error continues to occur, please contact support." } 
+    let(:error) do
+      { code: code, short_description: short_description, long_description: long_description }.to_json
+    end
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs")
+        .to_return(status: code, body: error, headers: {})
+    end 
+
+    it "should return the correct error" do
+      expect { subject.faqs }.to raise_error do |error|
+        error.code.should == code
+        error.short_description.should == short_description
+        error.long_description.should == long_description
+      end
+    end
+  end
+
+  describe "400" do
+    let(:code) { 400 }
+    let(:short_description) { 'BadRequest' }
+    let(:long_description) { "The system did not receive the necessary parameters to complete the request. Please check your request and try again." } 
+    let(:error) do
+      { code: code, short_description: short_description, long_description: long_description }.to_json
+    end
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs")
+        .to_return(status: code, body: error, headers: {})
+    end 
+
+    it "should return the correct error" do
+      expect { subject.faqs }.to raise_error do |error|
+        error.code.should == code
+        error.short_description.should == short_description
+        error.long_description.should == long_description
+      end
+    end
+  end
+
+  describe "401" do
+    let(:code) { 401 }
+    let(:short_description) { 'Unauthorized' }
+    let(:long_description) { 'The system was unable to authenticate your request. Please check your credentials and try again.' } 
+    let(:error) do
+      { code: code, short_description: short_description, long_description: long_description }.to_json
+    end
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs")
+        .to_return(status: code, body: error, headers: {})
+    end 
+
+    it "should return the correct error" do
+      expect { subject.faqs }.to raise_error do |error|
+        error.code.should == code
+        error.short_description.should == short_description
+        error.long_description.should == long_description
+      end
+    end
+  end
+
+  describe "404" do
+    let(:code) { 404 }
+    let(:short_description) { 'NotFound' }
+    let(:long_description) { 'The system was unable to locate the specified object. Please check your request and try again.'} 
+    let(:error) do
+      { code: code, short_description: short_description, long_description: long_description }.to_json
+    end
+    let(:response) { subject.faqs }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs")
+        .to_return(status: code, body: error, headers: {})
+    end 
+
+    it { response.should == nil }
+  end
+end

data/spec/features/faqs_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Faq Retrieval" do
+  let(:api_key) { 'api_key' }
+  let(:app_key) { 'app_key' }
+  let(:version) { 'v1' }
+
+  subject do 
+    Supportify::Client.new api_key: api_key,
+                           app_key: app_key,
+                           version: version
+  end
+
+  describe "When retrieving multiple Faqs" do
+    let(:faqs) { build_list :faq_with_categories_and_tags, rand(1..5) } 
+    let(:response) { subject.faqs }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs")
+        .to_return(status: 200, body: { 'faqs' => faqs }.to_json, headers: {})
+    end
+
+    it { response.should be_a Array }
+    it { response.each { |r| r.should be_a Supportify::Api::Faq } }
+  end
+
+  describe "When retrieving a single Faq" do
+    let(:faq) { build :faq_with_categories_and_tags } 
+    let(:response) { subject.faqs(1) }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/faqs/1")
+        .to_return(status: 200, body: { 'faq' => faq }.to_json, headers: {})
+    end
+
+    it { response.should be_a(Supportify::Api::Faq) }
+  end
+
+  describe "When passing in additional arguments" do
+    let(:fields) { 'id,question,answer' } 
+    let(:sort) { 'question-asc' } 
+
+    before do
+      stub_request(:get, "https://api.supportify.io/v1/faqs").
+        to_return(:status => 200, :body => "", :headers => {})
+
+      subject.faqs fields: fields, sort: sort
+    end
+
+    it "should have passed along the arguments" do
+      WebMock.should have_requested(:get, "https://api.supportify.io/v1/faqs")
+        .with(body: { fields: fields, sort: sort })
+    end
+  end
+end

data/spec/features/tags_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Tag Retrieval" do
+  let(:api_key) { 'api_key' }
+  let(:app_key) { 'app_key' }
+  let(:version) { 'v1' }
+
+  subject do 
+    Supportify::Client.new api_key: api_key,
+                           app_key: app_key,
+                           version: version
+  end
+
+  describe "When retrieving multiple Tags" do
+    let(:tags) { build_list :tag, rand(1..5) } 
+    let(:response) { subject.tags }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/tags")
+        .to_return(status: 200, body: { 'tags' => tags }.to_json, headers: {})
+    end
+
+    it { response.should be_a Array }
+    it { response.each { |r| r.should be_a Supportify::Api::Tag } }
+  end
+
+  describe "When retrieving a single Tag" do
+    let(:tag) { build :tag } 
+    let(:response) { subject.tags(1) }
+
+    before do
+      stub_request(:any, "https://api.supportify.io/v1/tags/1")
+        .to_return(status: 200, body: { 'tag' => tag }.to_json, headers: {})
+    end
+
+    it { response.should be_a(Supportify::Api::Tag) }
+  end
+
+  describe "When passing in additional arguments" do
+    let(:fields) { 'id,name' } 
+    let(:sort) { 'name-asc' } 
+
+    before do
+      stub_request(:get, "https://api.supportify.io/v1/tags").
+        to_return(:status => 200, :body => "", :headers => {})
+
+      subject.tags fields: fields, sort: sort
+    end
+
+    it "should have passed along the arguments" do
+      WebMock.should have_requested(:get, "https://api.supportify.io/v1/tags")
+        .with(body: { fields: fields, sort: sort })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'supportify_client'
+require 'webmock/rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,7 @@
+require 'factory_girl'
+
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods  
+end

data/spec/support/load_paths.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))

data/spec/support/simple_cov.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end

data/supportify_client.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "supportify_client"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jordan Yaker", "Supportify, Inc."]
+  s.date = "2014-08-27"
+  s.description = "Ruby client for the Supportify.io help and support API."
+  s.email = "jordan.yaker@supportify.io"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/supportify_client.rb",
+    "lib/supportify_client/api.rb",
+    "lib/supportify_client/api/category.rb",
+    "lib/supportify_client/api/error.rb",
+    "lib/supportify_client/api/faq.rb",
+    "lib/supportify_client/api/tag.rb",
+    "lib/supportify_client/client.rb",
+    "lib/supportify_client/factory.rb",
+    "lib/supportify_client/gateway.rb",
+    "lib/supportify_client/repository.rb",
+    "lib/supportify_client/version.rb",
+    "spec/factories.rb",
+    "spec/features/categories_spec.rb",
+    "spec/features/client_spec.rb",
+    "spec/features/errors_spec.rb",
+    "spec/features/faqs_spec.rb",
+    "spec/features/tags_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factory_girl.rb",
+    "spec/support/load_paths.rb",
+    "spec/support/simple_cov.rb",
+    "supportify_client.gemspec"
+  ]
+  s.homepage = "http://github.com/supportify/supportify_ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.6"
+  s.summary = "Ruby client for the Supportify.io help and support API."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, ["~> 1.7.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, ["~> 1.7.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<pry-byebug>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, ["~> 1.7.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<pry-byebug>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: supportify_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jordan Yaker
+- Supportify, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for the Supportify.io help and support API.
+email: jordan.yaker@supportify.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/supportify_client.rb
+- lib/supportify_client/api.rb
+- lib/supportify_client/api/category.rb
+- lib/supportify_client/api/error.rb
+- lib/supportify_client/api/faq.rb
+- lib/supportify_client/api/tag.rb
+- lib/supportify_client/client.rb
+- lib/supportify_client/factory.rb
+- lib/supportify_client/gateway.rb
+- lib/supportify_client/repository.rb
+- lib/supportify_client/version.rb
+- spec/factories.rb
+- spec/features/categories_spec.rb
+- spec/features/client_spec.rb
+- spec/features/errors_spec.rb
+- spec/features/faqs_spec.rb
+- spec/features/tags_spec.rb
+- spec/spec_helper.rb
+- spec/support/factory_girl.rb
+- spec/support/load_paths.rb
+- spec/support/simple_cov.rb
+- supportify_client.gemspec
+homepage: http://github.com/supportify/supportify_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Supportify.io help and support API.
+test_files: []