assistly 0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+pkg/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.1
+  - 1.9.2
+  - jruby
+  - rbx
+  - ree

data/.yardopts

@@ -0,0 +1,9 @@
+--no-private
+--protected
+--tag format:"Supported formats"
+--tag authenticated:"Requires Authentication"
+--tag rate_limited:"Rate Limited"
+--markup markdown
+-
+HISTORY.mkd
+LICENSE.mkd

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gemspec
+
+
+group :development do
+  gem "ruby-debug"
+end
+
+group :test do
+  gem "ruby-debug"
+end

data/HISTORY.mkd

@@ -0,0 +1,4 @@
+0.1 - April 12, 2011
+-------------------------
+* Initial release
+* Support for Case, Customer, Interaction, and User APIs.

data/LICENSE.mkd

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Warren
+
+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.mkd

@@ -0,0 +1,121 @@
+The Assistly Ruby Gem
+====================
+A Ruby wrapper for the Assistly API
+
+Installation
+------------
+    gem install assistly
+
+What's new in 0.1?
+------------------
+This is the first release of the Assistly gem, based on the [Twitter gem](http://github.com/jnunemaker/twitter). Support for most of the [Assistly API](http://dev.assistly.com/docs/api) are handled.
+There is not yet support for Content or Macros.
+
+Help! I'm getting: "Did not recognize your engine specification. Please specify either a symbol or a class. (RuntimeError)"
+---------------------------------------------------------------------------------------------------------------------------
+
+You'll need to explicitly require a JSON library. We recommend [yajl-ruby](http://github.com/brianmario/yajl-ruby).
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "assistly"
+
+    # All methods require authentication. To get your Assistly OAuth credentials,
+    # register an app in the Assistly admin for your account at http://your-domain.assistly.com/admin
+    @assistly = Assistly.configure do |config|
+      config.consumer_key = YOUR_CONSUMER_KEY
+      config.consumer_secret = YOUR_CONSUMER_SECRET
+      config.oauth_token = YOUR_OAUTH_TOKEN
+      config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
+    end
+    
+    # List cases
+    @assistly.cases
+    @assistly.cases(:since_id => 12345)
+    
+    # Get a specific case
+    @assistly.case(12345)
+    
+    # Update a specific case
+    @assistly.update_case(12345, :subject => "Something Else")
+    
+    # List customers
+    @assistly.customers
+    @assistly.customers(:since_id => 12345, :count => 5)
+    
+    # Get a specific customer
+    @assistly.customer(12345)
+    
+    # Create a customer
+    @assistly.create_customer(:name => "Chris Warren", :twitter => "cdwarren")
+    
+    # Update a customer
+    @assistly.update_customer(12345, :name => "Christopher Warren")
+    
+    # Add a customer email
+    @assistly.create_customer_email(12345, "foo@example.com")
+    @assistly.create_customer_email(12345, "foo@example.com", :customer_contact_type => "work")
+    
+    # Update a customer email
+    @assistly.update_customer_email(12345, 54321, :email => "foo@example.com")
+    @assistly.update_customer_email(12345, 54321, :customer_contact_type => "work")
+    
+    # List interactions
+    @assistly.interactions
+    @assistly.interactions(:since_id => 12345)
+    @assistly.interactions(:since_id => 12345, :count => 5)
+    
+    # Create an interaction
+    @assistly.create_interaction(:interaction_subject => "this is a test", :customer_email => "foo@example.com")
+    
+    # List users
+    @assistly.users
+    
+    # Get a specific user
+    @assistly.user(12345)
+
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues](http://github.com/chriswarren/assistly/issues)
+* by reviewing patches
+
+All contributors will be added to the [HISTORY](https://github.com/chriswarren/twitter/blob/master/HISTORY.mkd)
+file and will receive the respect and gratitude of the community.
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/chriswarren/assistly/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Copyright
+---------
+Copyright (c) 2011 Chris Warren
+See [LICENSE](https://github.com/chriswarren/assistly/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/assistly.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/assistly/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('json', '~> 1.5')
+  s.add_development_dependency('nokogiri', '~> 1.4')
+  s.add_development_dependency('maruku', '~> 0.6')
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_development_dependency('simplecov', '~> 0.4')
+  s.add_development_dependency('webmock', '~> 1.6')
+  s.add_development_dependency('yard', '~> 0.6')
+  s.add_development_dependency('ZenTest', '~> 4.5')
+  s.add_runtime_dependency('hashie', '~> 1.0.0')
+  s.add_runtime_dependency('faraday', '~> 0.6.0')
+  s.add_runtime_dependency('faraday_middleware', '~> 0.6.3')
+  s.add_runtime_dependency('jruby-openssl', '~> 0.7.2') if RUBY_PLATFORM == 'java'
+  s.add_runtime_dependency('multi_json', '~> 0.0.5')
+  s.add_runtime_dependency('multi_xml', '~> 0.2.0')
+  s.add_runtime_dependency('rash', '~> 0.3.0')
+  s.add_runtime_dependency('simple_oauth', '~> 0.1.4')
+  s.authors = ["Chris Warren"]
+  s.description = %q{A Ruby wrapper for the Assistly REST API, based on the Twitter gem}
+  s.post_install_message =<<eos
+********************************************************************************
+
+Ruby wrapper for the Assistly API, based on https://github.com/jnunemaker/twitter/.
+
+********************************************************************************
+eos
+  s.email = ['chris@zencoder.com']
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/chriswarren/assistly'
+  s.name = 'assistly'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = s.name
+  s.summary = %q{Ruby wrapper for the Assistly API, based on the Twitter gem}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Assistly::VERSION.dup
+end

data/lib/assistly.rb

@@ -0,0 +1,26 @@
+require 'assistly/error'
+require 'assistly/configuration'
+require 'assistly/api'
+require 'assistly/client'
+# require 'assistly/search'
+
+module Assistly
+  extend Configuration
+
+  # Alias for Assistly::Client.new
+  #
+  # @return [Assistly::Client]
+  def self.client(options={})
+    Assistly::Client.new(options)
+  end
+
+  # Delegate to Assistly::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method)
+    client.respond_to?(method) || super
+  end
+end

data/lib/assistly/api.rb

@@ -0,0 +1,23 @@
+require 'assistly/connection'
+require 'assistly/request'
+require 'assistly/authentication'
+
+module Assistly
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Assistly.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+    include Authentication
+  end
+end

data/lib/assistly/authentication.rb

@@ -0,0 +1,25 @@
+module Assistly
+  # @private
+  module Authentication
+    private
+
+    # Authentication hash
+    #
+    # @return [Hash]
+    def authentication
+      {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :token => oauth_token,
+        :token_secret => oauth_token_secret
+      }
+    end
+
+    # Check whether user is authenticated
+    #
+    # @return [Boolean]
+    def authenticated?
+      authentication.values.all?
+    end
+  end
+end

data/lib/assistly/client.rb

@@ -0,0 +1,25 @@
+module Assistly
+  # Wrapper for the Assistly REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in {http://dev.assistly.com/doc the Assistly API Documentation}.
+  # @see http://dev.assistly.com/pages/every_developer
+  class Client < API
+    # Require client method modules after initializing the Client class in
+    # order to avoid a superclass mismatch error, allowing those modules to be
+    # Client-namespaced.
+    require 'assistly/client/utils'
+    require 'assistly/client/user'
+    require 'assistly/client/interaction'
+    require 'assistly/client/case'
+    require 'assistly/client/customer'
+
+    alias :api_endpoint :endpoint
+
+    include Assistly::Client::Utils
+
+    include Assistly::Client::User
+    include Assistly::Client::Interaction
+    include Assistly::Client::Case
+    include Assistly::Client::Customer
+  end
+end

data/lib/assistly/client/case.rb

@@ -0,0 +1,51 @@
+module Assistly
+  class Client
+    # Defines methods related to cases
+    module Case
+      # Returns extended information of cases
+      #
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for 12345
+      #     Assistly.cases(:case_id => 12345)
+      #     Assistly.cases(:email => "customer@example.com", :count => 5)
+      #     Assistly.cases(:since_id => 12345)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/cases/show
+      def cases(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("cases",options)
+        response['results']
+      end
+      
+      # Returns extended information on a single case
+      #
+      #   @option options [String]
+      #   @example Return extended information for 12345
+      #     Assistly.case(12345)
+      #     Assistly.case(12345, :by => "external_id")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/cases/show
+      def case(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("cases/#{id}",options)
+        response.case
+      end
+      
+      # Updates a single case
+      #
+      #   @option options [String]
+      #   @example Return extended information for 12345
+      #     Assistly.update_case(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/cases/update
+      def update_case(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("cases/#{id}",options)
+        response.case
+      end
+    end
+  end
+end

data/lib/assistly/client/customer.rb

@@ -0,0 +1,108 @@
+module Assistly
+  class Client
+    # Defines methods related to customers
+    module Customer
+      # Returns extended information of customers
+      #
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for customers
+      #     Assistly.customers
+      #     Assistly.customers(:since_id => 12345, :count => 5)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/customers
+      def customers(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("customers",options)
+        response['results']
+      end
+      
+      # Returns extended information on a single customer
+      #
+      #   @option options [String]
+      #   @example Return extended information for customer 12345
+      #     Assistly.customer(12345)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/customers/show
+      def customer(id)
+        response = get("customers/#{id}")
+        response.customer
+      end
+
+      # Create a new customer
+      #
+      #   @option options [String]
+      #   @example Return extended information for 12345
+      #     Assistly.create_customer(:name => "Chris Warren", :twitter => "cdwarren")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/customers/create
+      def create_customer(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = post("customers",options)
+        if response['success']
+          return response['results']['customer']
+        else
+          return response['errors']
+        end
+      end
+      
+      # Update a customer
+      #
+      #   @option options [String]
+      #   @example Return extended information for 12345
+      #     Assistly.update_customer(12345, :name => "Christopher Warren")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/customers/update
+      def update_customer(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("customers/#{id}",options)
+        if response['success']
+          return response['results']['customer']
+        else
+          return response['errors']
+        end
+      end
+      
+      # Create a new customer email
+      #
+      #   @option options [String]
+      #   @example Return extended information for 12345
+      #     Assistly.create_customer_email(12345, "foo@example.com")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/customers/emails/create
+      def create_customer_email(id, email, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        options.merge!({:email => email})
+        response = post("customers/#{id}/emails",options)
+        if response['success']
+          return response['results']['email']
+        else
+          return response['errors']
+        end
+      end
+      
+      # Update a customer's email
+      #
+      #   @option options [String]
+      #   @example Return extended information for 12345
+      #     Assistly.update_customer_email(12345, 12345, :email => "foo@example.com")
+      #     Assistly.update_customer_email(12345, 12345, :customer_contact_type => "work")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/customers/emails/update
+      def update_customer_email(id, email_id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("customers/#{id}/emails/#{email_id}",options)
+        if response['success']
+          return response['results']['email']
+        else
+          return response['errors']
+        end
+      end
+    end
+  end
+end