supportify_client 0.0.4 → 1.0.0

data/lib/supportify_client/client.rb

@@ -1,49 +0,0 @@
-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

@@ -1,29 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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 search(*args)
-      get Supportify::Api::Search, args
-    end
-
-    def vote(*args)
-      post Supportify::Api::Faq, args
-    end
-  end
-end

data/spec/features/categories_spec.rb

@@ -1,55 +0,0 @@
-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

@@ -1,50 +0,0 @@
-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

@@ -1,96 +0,0 @@
-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

@@ -1,55 +0,0 @@
-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/search_spec.rb

@@ -1,29 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe "Searching" 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 searching for content" do
-    let(:query) { 'testing' }
-
-    before do
-      stub_request(:get, "https://api.supportify.io/v1/search").
-        to_return(:status => 200, :body => "", :headers => {})
-
-      subject.search query: query
-    end
-
-    it "should have passed along the arguments" do
-      WebMock.should have_requested(:get, "https://api.supportify.io/v1/search")
-        .with(body: { query: query })
-    end
-  end
-end

data/spec/features/tags_spec.rb

@@ -1,55 +0,0 @@
-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