assistly 0.1.5 → 0.2.0

data/HISTORY.mkd

@@ -1,3 +1,8 @@
+0.2.0 - April 16, 2011
+-------------------------
+* Support for Topics, Articles, and Macros added
+* Update Readme
+
 0.1.5 - April 15, 2011
 -------------------------
 * Support for creating outbound interactions via email

data/README.mkd

@@ -1,11 +1,20 @@
 The Assistly Ruby Gem
 ====================
-A Ruby wrapper for the Assistly API
+A Ruby wrapper for the [Assistly API](http://dev.assistly.com/)
 
 Installation
 ------------
     gem install assistly
 
+What's new in 0.2.0?
+------------------
+Added support for Topics, Articles, and Macros, which is currently all that is available in the Assistly API.
+
+What's new in 0.1.5?
+------------------
+Added the ability to create outbound communications over email
+
+
 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.
@@ -24,6 +33,7 @@ Usage Examples
     # 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.support_email = "help@example.com"
       config.subdomain = YOUR_ASSISTLY_SUBDOMAIN
       config.consumer_key = YOUR_CONSUMER_KEY
       config.consumer_secret = YOUR_CONSUMER_SECRET
@@ -31,6 +41,10 @@ Usage Examples
       config.oauth_token_secret = YOUR_OAUTH_TOKEN_SECRET
     end
 
+    ######
+    # Cases
+    ######
+
     # List cases
     @assistly.cases
     @assistly.cases(:since_id => 12345)
@@ -43,6 +57,10 @@ Usage Examples
 
     # Get a case url
     @assistly.case_url(12345)
+    
+    ######
+    # Customers
+    ######
 
     # List customers
     @assistly.customers
@@ -64,6 +82,10 @@ Usage Examples
     # Update a customer email
     @assistly.update_customer_email(12345, 54321, :email => "foo@example.com")
     @assistly.update_customer_email(12345, 54321, :customer_contact_type => "work")
+    
+    ######
+    # Interactions
+    ######
 
     # List interactions
     @assistly.interactions
@@ -85,11 +107,81 @@ Usage Examples
     @assistly.create_interaction(:interaction_subject => "Missed Your Call", :customer_email => "foo@example.com", :interaction_body => "Sorry we missed yoru call. What's up?", :direction => "outbound")
     @assistly.create_outbound_interaction("foo@example.com", "Missed Your Call", "Sorry we missed yoru call. What's up?")
 
+    ######
+    # Users
+    ######
+
     # List users
     @assistly.users
 
     # Get a specific user
     @assistly.user(12345)
+    
+    ######
+    # Topics
+    ######
+    
+    # List Topics
+    @assistly.topics
+    
+    # Get a specific topic
+    @assistly.topic(12345)
+    
+    # Create a new topic
+    @assistly.create_topic("name", :description => "description")
+    
+    # Update a topic
+    @assistly.update_topic(12345, :subject => "Updated")
+    
+    # Delete a topic
+    @assistly.delete_topic(12345)
+    
+    ######
+    # Articles
+    ######
+    
+    # List articles for a topic
+    @assistly.articles(1)
+    
+    # Get a specific article
+    @assistly.article(12345)
+    
+    # Create a new article within a topic
+    @assistly.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+    
+    # Update an article
+    @assistly.update_article(12345, :subject => "Updated API Tips")
+    
+    # Delete an article
+    @assistly.delete_article(12345)
+    
+    ######
+    # Macros
+    ######
+    
+    # List Macros
+    @assistly.macros
+
+    # Get a specific macro
+    @assistly.macro(12345)
+
+    # Create a new macro
+    @assistly.create_macro("name", :labels => "escalated")
+
+    # Update a macro
+    @assistly.update_macro(12345, :name => "Updated Name")
+
+    # Delete a macro
+    @assistly.delete_macro(12345)
+    
+    # Macro Actions
+    @assistly.macro_actions(12345)
+    
+    # Macro Action
+    @assistly.macro_action(12345, "set-case-description")
+    
+    # Update Macro Action
+    @assistly.update_macro_action(12345, "set-case-description", :value => "New Subject")
 
 Contributing
 ------------
@@ -133,5 +225,5 @@ Submitting a Pull Request
 
 Copyright
 ---------
-Copyright (c) 2011 Chris Warren/Zencoder
+Copyright (c) 2011 Chris Warren/[Zencoder](http://zencoder.com)
 See [LICENSE](https://github.com/zencoder/assistly/blob/master/LICENSE.mkd) for details.

data/lib/assistly/client.rb

@@ -12,6 +12,9 @@ module Assistly
     require 'assistly/client/interaction'
     require 'assistly/client/case'
     require 'assistly/client/customer'
+    require 'assistly/client/topic'
+    require 'assistly/client/article'
+    require 'assistly/client/macro'
 
     alias :api_endpoint :endpoint
 
@@ -21,5 +24,8 @@ module Assistly
     include Assistly::Client::Interaction
     include Assistly::Client::Case
     include Assistly::Client::Customer
+    include Assistly::Client::Topic
+    include Assistly::Client::Article
+    include Assistly::Client::Macro
   end
 end

data/lib/assistly/client/article.rb

@@ -0,0 +1,96 @@
+module Assistly
+  class Client
+    # Defines methods related to articles
+    module Article
+      # Returns extended information of articles for a topic
+      #
+      #   @param id [Integer] a article ID
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for 12345
+      #     Assistly.articles
+      #     Assistly.articles(:count => 5)
+      #     Assistly.articles(:count => 5, :page => 3)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/topics/articles
+      def articles(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("topics/#{id}/articles",options)
+        if response['results']
+          return response['results']
+        else
+          return response
+        end
+      end
+      
+      # Returns extended information on a single article
+      #
+      #   @param id [Integer] a article ID
+      #   @option options [Hash]
+      #   @example Return extended information for 12345
+      #     Assistly.article(12345)
+      #     Assistly.article(12345, :by => "external_id")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/articles/show
+      def article(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("articles/#{id}",options)
+        response.article
+      end
+      
+      # Creates a new article
+      #
+      #   @param id [Integer] a article ID
+      #   @param id [Integer] a article ID
+      #   @param id [Integer] a article ID
+      #   @option options [Hash]
+      #   @example Creates a new article
+      #     Assistly.create_article(1, :subject => "API Tips", :main_content => "Tips on using our API")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/articles/create
+      def create_article(topic_id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = post("topics/#{topic_id}/articles",options)
+        if response['success']
+          return response['results']['article']
+        else
+          return response
+        end
+      end
+      
+      # Updates a single article
+      #
+      #   @param id [Integer] a article ID
+      #   @option options [String]
+      #   @example Updates information for article 12345
+      #     Assistly.update_article(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/articles/update
+      def update_article(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("articles/#{id}",options)
+        if response['success']
+          return response['results']['article']
+        else
+          return response
+        end
+      end
+      
+      # Deletes a single article
+      #
+      #   @param id [Integer] a article ID
+      #   @example Deletes article 12345
+      #     Assistly.update_article(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/articles/update
+      def delete_article(id)
+        response = delete("articles/#{id}")
+        response
+      end
+    end
+  end
+end

data/lib/assistly/client/macro.rb

@@ -0,0 +1,142 @@
+module Assistly
+  class Client
+    # Defines methods related to macros
+    module Macro
+      # Returns extended information of macros
+      #
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for 12345
+      #     Assistly.macros
+      #     Assistly.macros(:count => 5)
+      #     Assistly.macros(:count => 5, :page => 3)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros
+      def macros(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("macros",options)
+        response['results']
+      end
+      
+      # Returns extended information on a single macro
+      #
+      #   @param id [Integer] a macro ID
+      #   @option options [Hash]
+      #   @example Return extended information for 12345
+      #     Assistly.macro(12345)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/show
+      def macro(id)
+        response = get("macros/#{id}")
+        response.macro
+      end
+      
+      # Creates a new macro
+      #
+      #   @param name [String] A macro name
+      #   @option options [Hash]
+      #   @example Creates a new macro
+      #     Assistly.create_macro("name")
+      #     Assistly.create_macro("name")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/create
+      def create_macro(name, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = post("macros",options)
+        if response['success']
+          return response['results']['macro']
+        else
+          return response
+        end
+      end
+      
+      # Updates a single macro
+      #
+      #   @param id [Integer] a macro ID
+      #   @option options [String]
+      #   @example Updates information for macro 12345
+      #     Assistly.update_macro(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/update
+      def update_macro(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("macros/#{id}",options)
+        if response['success']
+          return response['results']['macro']
+        else
+          return response
+        end
+      end
+      
+      # Deletes a single macro
+      #
+      #   @param id [Integer] a macro ID
+      #   @example Deletes macro 12345
+      #     Assistly.update_macro(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/update
+      def delete_macro(id)
+        response = delete("macros/#{id}")
+        response
+      end
+      
+      ##########
+      # Macro Actions
+      ##########
+      
+      # Returns extended information of macros
+      #
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for 12345
+      #     Assistly.macro_actions(1)
+      #     Assistly.macro_actions(1, :count => 5)
+      #     Assistly.macro_actions(1, :count => 5, :page => 3)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/actions
+      def macro_actions(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("macros/#{id}/actions",options)
+        response['results']
+      end
+      
+      # Returns extended information on a single macro
+      #
+      #   @param id [Integer] a macro ID
+      #   @option options [Hash]
+      #   @example Return extended information for 12345
+      #     Assistly.macro_action(12345, "set-case-description")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/actions/show
+      def macro_action(id, slug)
+        response = get("macros/#{id}/actions/#{slug}")
+        response['action']
+      end
+      
+      # Updates a single macro action
+      #
+      #   @param id [Integer] a macro ID
+      #   @option options [String]
+      #   @example Updates information for macro 12345
+      #     Assistly.update_macro_action(12345, "set-case-description", :value => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/macros/actions/update
+      def update_macro_action(id, slug, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("macros/#{id}/actions/#{slug}",options)
+        if response['success']
+          return response['results']['action']
+        else
+          return response
+        end
+      end
+      
+    end
+  end
+end

data/lib/assistly/client/topic.rb

@@ -0,0 +1,90 @@
+module Assistly
+  class Client
+    # Defines methods related to topics
+    module Topic
+      # Returns extended information of topics
+      #
+      #   @option options [Boolean, String, Integer]
+      #   @example Return extended information for 12345
+      #     Assistly.topics
+      #     Assistly.topics(:count => 5)
+      #     Assistly.topics(:count => 5, :page => 3)
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/topics/show
+      def topics(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("topics",options)
+        response['results']
+      end
+      
+      # Returns extended information on a single topic
+      #
+      #   @param id [Integer] a topic ID
+      #   @option options [Hash]
+      #   @example Return extended information for 12345
+      #     Assistly.topic(12345)
+      #     Assistly.topic(12345, :by => "external_id")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/topics/show
+      def topic(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = get("topics/#{id}",options)
+        response.topic
+      end
+      
+      # Creates a new topic
+      #
+      #   @param name [String] A topic name
+      #   @option options [Hash]
+      #   @example Creates a new topic
+      #     Assistly.create_topic("name")
+      #     Assistly.create_topic("name", :description => "description")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/topics/create
+      def create_topic(name, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = post("topics",options)
+        if response['success']
+          return response['results']['topic']
+        else
+          return response
+        end
+      end
+      
+      # Updates a single topic
+      #
+      #   @param id [Integer] a topic ID
+      #   @option options [String]
+      #   @example Updates information for topic 12345
+      #     Assistly.update_topic(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/topics/update
+      def update_topic(id, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        response = put("topics/#{id}",options)
+        if response['success']
+          return response['results']['topic']
+        else
+          return response
+        end
+      end
+      
+      # Deletes a single topic
+      #
+      #   @param id [Integer] a topic ID
+      #   @example Deletes topic 12345
+      #     Assistly.update_topic(12345, :subject => "New Subject")
+      # @format :json
+      # @authenticated true
+      # @see http://dev.assistly.com/docs/api/topics/update
+      def delete_topic(id)
+        response = delete("topics/#{id}")
+        response
+      end
+    end
+  end
+end