assistly 0.1

data/lib/assistly/version.rb

@@ -0,0 +1,4 @@
+module Assistly
+  # The version of the gem
+  VERSION = '0.1'.freeze unless defined?(::Assistly::VERSION)
+end

data/lib/faraday/request/multipart_with_file.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::MultipartWithFile < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        env[:body].each do |key, value|
+          if value.is_a?(File)
+            env[:body][key] = Faraday::UploadIO.new(value, mime_type(value), value.path)
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(file)
+      case file.path
+        when /\.jpe?g/i then 'image/jpeg'
+        when /\.gif$/i then 'image/gif'
+        when /\.png$/i then 'image/png'
+        else 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_http_4xx.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp4xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise Assistly::BadRequest.new(error_message(env), env[:response_headers])
+      when 401
+        raise Assistly::Unauthorized.new(error_message(env), env[:response_headers])
+      when 403
+        raise Assistly::Forbidden.new(error_message(env), env[:response_headers])
+      when 404
+        raise Assistly::NotFound.new(error_message(env), env[:response_headers])
+      when 406
+        raise Assistly::NotAcceptable.new(error_message(env), env[:response_headers])
+      when 420
+        raise Assistly::EnhanceYourCalm.new(error_message(env), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]}#{error_body(env[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = body['errors'].to_a.first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_http_5xx.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp5xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 500
+        raise Assistly::InternalServerError.new(error_message(env, "Something is technically wrong."), env[:response_headers])
+      when 502
+        raise Assistly::BadGateway.new(error_message(env, "Assistly is down or being upgraded."), env[:response_headers])
+      when 503
+        raise Assistly::ServiceUnavailable.new(error_message(env, "(__-){ Assistly is over capacity."), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env, body=nil)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{[env[:status].to_s + ':', body].compact.join(' ')} Check http://status.twitter.com/ for updates on the status of the Assistly service."
+    end
+  end
+end

data/spec/assistly/api_spec.rb

@@ -0,0 +1,70 @@
+require 'helper'
+
+describe Assistly::API do
+  before do
+    @keys = Assistly::Configuration::VALID_OPTIONS_KEYS
+  end
+
+  context "with module configuration" do
+
+    before do
+      Assistly.configure do |config|
+        @keys.each do |key|
+          config.send("#{key}=", key)
+        end
+      end
+    end
+
+    after do
+      Assistly.reset
+    end
+
+    it "should inherit module configuration" do
+      api = Assistly::API.new
+      @keys.each do |key|
+        api.send(key).should == key
+      end
+    end
+
+    context "with class configuration" do
+
+      before do
+        @configuration = {
+          :consumer_key => 'CK',
+          :consumer_secret => 'CS',
+          :oauth_token => 'OT',
+          :oauth_token_secret => 'OS',
+          :adapter => :typhoeus,
+          :endpoint => 'http://tumblr.com/',
+          :format => :xml,
+          :proxy => 'http://erik:sekret@proxy.example.com:8080',
+          :subdomain => 'zencoder',
+          :user_agent => 'Custom User Agent',
+          :version => "amazing"
+        }
+      end
+
+      context "during initialization"
+
+        it "should override module configuration" do
+          api = Assistly::API.new(@configuration)
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+
+      context "after initilization" do
+
+        it "should override module configuration after initialization" do
+          api = Assistly::API.new
+          @configuration.each do |key, value|
+            api.send("#{key}=", value)
+          end
+          @keys.each do |key|
+            api.send(key).should == @configuration[key]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/assistly/client/case_spec.rb

@@ -0,0 +1,88 @@
+require 'helper'
+
+describe Assistly::Client do
+  Assistly::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Assistly::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".cases" do
+
+        context "lookup" do
+
+          before do
+            stub_get("cases.#{format}").
+              to_return(:body => fixture("cases.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.cases
+            a_get("cases.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            cases = @client.cases
+            
+            cases.should be_a Array
+            cases.first.case.id.should == 1
+            cases.first.case.user.name.should == "Jeremy Suriel"
+          end
+
+        end
+      end
+      
+      describe ".case" do
+
+        context "lookup" do
+
+          before do
+            stub_get("cases/1.#{format}").
+              to_return(:body => fixture("case.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.case(1)
+            a_get("cases/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            a_case = @client.case(1)
+            
+            a_case.id.should == 1
+            a_case.external_id.should == "123"
+            a_case.subject.should == "Welcome to Assistly"
+          end
+
+        end
+      end
+      
+      describe ".update_case" do
+
+        context "update" do
+
+          before do
+            stub_put("cases/1.#{format}").
+              to_return(:body => fixture("case_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.update_case(1, :subject => "Welcome to Assistly")
+            a_put("cases/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 cases worth of extended information" do
+            a_case = @client.update_case(1, :subject => "Welcome to Assistly")
+            
+            a_case.id.should == 1
+            a_case.subject.should == "Welcome to Assistly"
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/assistly/client/customer_spec.rb

@@ -0,0 +1,158 @@
+require 'helper'
+
+describe Assistly::Client do
+  Assistly::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Assistly::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".customers" do
+
+        context "lookup" do
+
+          before do
+            stub_get("customers.#{format}").
+              to_return(:body => fixture("customers.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.customers
+            a_get("customers.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 customers worth of extended information" do
+            customers = @client.customers
+
+            customers.should be_a Array
+            customers.first.customer.first_name.should == "Jeremy"
+          end
+
+        end
+      end
+
+      describe ".customer" do
+
+        context "lookup" do
+
+          before do
+            stub_get("customers/1.#{format}").
+              to_return(:body => fixture("customer.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.customer(1)
+            a_get("customers/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 customers worth of extended information" do
+            customer = @client.customer(1)
+
+            customer.first_name.should == "Jeremy"
+            customer.addresses.first.address.city.should == "Commack"
+          end
+
+        end
+      end
+      
+      describe ".create_customer" do
+
+        context "create" do
+
+          before do
+            stub_post("customers.#{format}").
+              to_return(:body => fixture("customer_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_customer(:name => "Chris Warren", :twitter => "cdwarren")
+            a_post("customers.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            customer = @client.create_customer(:name => "John Smith", :twitter => "cdwarren")
+
+            customer.first_name.should == "John"
+            customer.phones.first.phone.phone.should == "123-456-7890"
+          end
+
+        end
+      end
+      
+      describe ".update_customer" do
+
+        context "update" do
+
+          before do
+            stub_put("customers/1.#{format}").
+              to_return(:body => fixture("customer_update.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.update_customer(1, :name => "Chris Warren", :twitter => "cdwarren")
+            a_put("customers/1.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            customer = @client.update_customer(1, :name => "Joslyn Esser")
+
+            customer.first_name.should == "Joslyn"
+          end
+
+        end
+      end
+      
+      describe ".create_customer_email" do
+
+        context "create" do
+
+          before do
+            stub_post("customers/1/emails.#{format}").
+              to_return(:body => fixture("customer_create_email.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_customer_email(1, :email => "foo@example.com")
+            a_post("customers/1/emails.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            email = @client.create_customer_email(1, :email => "api@example.com")
+
+            email.email.should == "api@example.com"
+          end
+
+        end
+      end
+      
+      describe ".update_customer_email" do
+
+        context "update" do
+
+          before do
+            stub_put("customers/1/emails/2.#{format}").
+              to_return(:body => fixture("customer_update_email.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.update_customer_email(1, 2, :email => "foo@example.com")
+            a_put("customers/1/emails/2.#{format}").
+              should have_been_made
+          end
+
+          it "should return the information about this user" do
+            email = @client.update_customer_email(1, 2, :email => "api@example.com")
+
+            email.email.should == "api@example.com"
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/assistly/client/interaction_spec.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+describe Assistly::Client do
+  Assistly::Configuration::VALID_FORMATS.each do |format|
+    context ".new(:format => '#{format}')" do
+      before do
+        @client = Assistly::Client.new(:subdomain => "example", :format => format, :consumer_key => 'CK', :consumer_secret => 'CS', :oauth_token => 'OT', :oauth_token_secret => 'OS')
+      end
+
+      describe ".create_interaction" do
+        context "create a new interaction" do
+          before do
+            stub_post("interactions.#{format}").
+              to_return(:body => fixture("interaction_create.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
+            a_post("interactions.#{format}").
+              should have_been_made
+          end
+
+          it "should create an interaction" do
+            interaction = @client.create_interaction(:interaction_subject => "this is an api test", :customer_email => "foo@example.com")
+
+            interaction.customer.emails.first.email.email.should == "customer@zencoder.com"
+            interaction.interaction.interactionable.email.subject.should == "this is an api test"
+          end
+        end
+      end
+
+      describe ".interactions" do
+
+        context "lookup" do
+
+          before do
+            stub_get("interactions.#{format}").
+              to_return(:body => fixture("interactions.#{format}"), :headers => {:content_type => "application/#{format}; charset=utf-8"})
+          end
+
+          it "should get the correct resource" do
+            @client.interactions
+            a_get("interactions.#{format}").
+              should have_been_made
+          end
+
+          it "should return up to 100 users worth of extended information" do
+            interactions = @client.interactions
+            
+            interactions.should be_a Array
+            interactions.last.interaction.user.name.should == "Agent Jeremy"
+          end
+
+        end
+      end
+    end
+  end
+end