desk_api_v2 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2JlYzYyMDg5NzcwZWRhMjc3M2JmZDY5OTkyNDBkNGZhN2UyMzk5ZQ==
+  data.tar.gz: !binary |-
+    YWU0Yzk0YzhiZWQ0MDUyN2Q3MTk5NzczMDJjNjgzNDJjMzJmNjA2Ng==
+SHA512:
+  metadata.gz: !binary |-
+    NjhjYjg1MDA0YTE2Y2NjMTZlNmQ5NTk0M2ZkMTJmYjE1ZjYxYjMxYjVjNWNm
+    MzhjNGRkOGVjZWFhMGRmNzY4NzY3MDM0N2JkMjFkNTc3NDBkYTc1ODBiNDUx
+    NTkzOTIyMzJiMGQzZTc5N2YxMTA5YzIxMTAwOGMzNDMxOTVmYjY=
+  data.tar.gz: !binary |-
+    YTI1OGQzZTQ1OWYzZjFiZDgwNWY5MjlhNGZjYTEyNjllYzUyNzM0MDE0NDA1
+    MmNlMTQyODcwNTkyZDEyNGU5YWM2ODMzODYxZjEwMjA5OGY3MzQzYjE5ODU0
+    MWUxMzNmZThmNzU3ZTc4NGVjZWVkMTNkN2ZkNjcwOTZhOGQ2NTU=

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,24 @@
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Justin Powers
+
+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.md

@@ -0,0 +1,27 @@
+A simple ruby interface to Desk.com
+
+## Installation
+    gem install desk_api_v2
+
+## Usage
+
+Oauth (recommended):
+
+    client = Desk::Client.new(site: "my-site-name", consumer_key: "consumer-key", consumer_secret: "consumer-secret", token: "token", token_secret: "token_secret")
+
+Basic Auth:
+
+    client = Desk::Client.new(site: "my-site-name", email: "email@example.com", password: "mypassword")
+
+Example usage:
+
+    client.cases.all
+    client.cases.show(1234)
+    client.cases.create(data)
+    client.cases.update(1234, data)
+    client.article.all
+
+## To do
+
+Add more endpoints  
+Pagination

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake/testtask'
+
+begin
+  require "bundler"
+  Bundler.setup
+rescue LoadError
+  $stderr.puts "You need to have Bundler installed to be able build this gem."
+end
+
+gemspec = eval(File.read(Dir["*.gemspec"].first))
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build gem locally"
+task :build => :gemspec do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p "pkg"
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", "pkg"
+end
+
+desc "Install gem locally"
+task :install => :build do
+  system "gem install pkg/#{gemspec.name}-#{gemspec.version}"
+end
+
+desc "Clean automatically generated files"
+task :clean do
+  FileUtils.rm_rf "pkg"
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+desc "Run Tests"
+task :default => :test

data/desk_api_v2.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name                     = "desk_api_v2"
+  s.version                  = "0.0.1"
+  s.platform                 = Gem::Platform::RUBY
+  s.authors                  = ["Justin Powers"]
+  s.email                    = ["justinspowers@gmail.com"]
+  s.homepage                 = "http://github.com/dangerp/desk"
+  s.summary                  = "A ruby interface to the Desk.com API V2"
+  s.description              = s.summary
+  s.licenses              = ['MIT']
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.files         = `git ls-files`.split("\n")
+
+  s.require_path = 'lib'
+
+  s.add_dependency "faraday_middleware", "~> 0.9.0"
+  s.add_dependency "activesupport", "~> 3.2.13"
+
+  s.add_development_dependency "pry", "~> 0.9.12"
+  s.add_development_dependency "rake", "~> 10.0.4"
+  s.add_development_dependency "webmock", "~> 1.11.0"
+  s.add_development_dependency "minitest", "~> 3.5.0"
+  s.add_development_dependency "minitest-reporters", "~> 0.14.20"
+end

data/lib/desk.rb

@@ -0,0 +1,11 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'desk/client'
+require 'desk/collection'
+require 'desk/entity'
+require 'desk/case'
+require 'desk/article'
+require 'desk/customer'
+require 'desk/topic'
+require 'desk/group'
+require 'desk/filter'

data/lib/desk/api/articles.rb

@@ -0,0 +1,34 @@
+require 'active_support/core_ext/hash'
+require 'desk/api/modules/listable'
+require 'desk/api/modules/creatable'
+require 'desk/api/modules/searchable'
+require 'desk/api/modules/deletable'
+require 'desk/article'
+
+module Desk
+  module Api
+    class Articles
+
+      include Desk::Api::Listable
+      include Desk::Api::Creatable
+      include Desk::Api::Searchable
+      include Desk::Api::Deletable
+
+      VALID_SEARCH_PARAMS = [:text, :topic_ids]
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "articles"
+        @return_class = Desk::Article
+      end
+
+      private
+
+      def valid_search_params
+        VALID_SEARCH_PARAMS
+      end
+    end
+  end
+end

data/lib/desk/api/cases.rb

@@ -0,0 +1,47 @@
+require 'active_support/core_ext/hash'
+require 'desk/api/modules/listable'
+require 'desk/api/modules/creatable'
+require 'desk/api/modules/searchable'
+require 'desk/case'
+require 'desk/message'
+
+module Desk
+  module Api
+    class Cases
+
+      include Desk::Api::Listable
+      include Desk::Api::Creatable
+      include Desk::Api::Searchable
+
+      VALID_SEARCH_PARAMS= [:name, :first_name, :last_name, :email, :phone,
+                            :company, :twitter, :labels, :case_id, :subject,
+                            :description, :status, :priority, :assigned_group,
+                            :assigned_user, :channels, :notes, :attachments,
+                            :case_custom_key, :created, :updated, :since_created_at,
+                            :max_created_at, :since_updated_at, :max_updated_at,
+                            :since_id, :max_id]
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "cases"
+        @return_class = Desk::Case
+      end
+
+      def message(id)
+        Desk::Message.new(connection.get("cases/#{id}/message"))
+      end
+
+      def replies(id)
+        Desk::Message.new(connection.get("cases/#{id}/replies"))
+      end
+
+      private
+
+      def valid_search_params
+        VALID_SEARCH_PARAMS
+      end
+    end
+  end
+end

data/lib/desk/api/customers.rb

@@ -0,0 +1,36 @@
+require 'active_support/core_ext/hash'
+require 'desk/api/modules/listable'
+require 'desk/api/modules/creatable'
+require 'desk/api/modules/searchable'
+require 'desk/api/modules/deletable'
+require 'desk/customer'
+
+module Desk
+  module Api
+    class Customers
+
+      include Desk::Api::Listable
+      include Desk::Api::Creatable
+      include Desk::Api::Searchable
+      include Desk::Api::Deletable
+
+      VALID_SEARCH_PARAMS = [:first_name, :last_name, :full_name, :email, :since_created_at,
+                             :max_created_at, :external_id, :since_updated_at, :max_updated_at,
+                             :since_id, :max_id, :twitter, :phone, :custom_N]
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "customers"
+        @return_class = Desk::Customer
+      end
+
+      private
+
+      def valid_search_params
+        VALID_SEARCH_PARAMS
+      end
+    end
+  end
+end

data/lib/desk/api/groups.rb

@@ -0,0 +1,30 @@
+require 'desk/api/modules/listable'
+require 'desk/customer'
+require 'desk/filter'
+require 'desk/user'
+
+module Desk
+  module Api
+    class Groups
+
+      include Desk::Api::Listable
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "groups"
+        @return_class = Desk::Group
+      end
+
+      def filters(id)
+        Desk::Collection.new(connection.get("groups/#{id}/filters"), Desk::Filter)
+      end
+
+      def users(id)
+        Desk::Collection.new(connection.get("groups/#{id}/users"), Desk::User)
+      end
+
+    end
+  end
+end

data/lib/desk/api/modules/creatable.rb

@@ -0,0 +1,15 @@
+module Desk
+  module Api
+    module Creatable
+
+      def create(data)
+        return_class.new(connection.post(endpoint, data))
+      end
+
+      def update(id, data)
+        return_class.new(connection.patch("#{endpoint}/#{id}", data))
+      end
+
+    end
+  end
+end

data/lib/desk/api/modules/deletable.rb

@@ -0,0 +1,11 @@
+module Desk
+  module Api
+    module Deletable
+
+      def delete(id)
+        connection.delete("#{endpoint}/#{id}")
+      end
+
+    end
+  end
+end

data/lib/desk/api/modules/listable.rb

@@ -0,0 +1,16 @@
+module Desk
+  module Api
+    module Listable
+
+      def all
+        Desk::Collection.new(connection.get(endpoint), return_class)
+      end
+
+      def show(id)
+        raise ArgumentError "Must provide an ID" unless id
+        return_class.new(connection.get("#{endpoint}/#{id}"))
+      end
+
+    end
+  end
+end

data/lib/desk/api/modules/searchable.rb

@@ -0,0 +1,13 @@
+module Desk
+  module Api
+    module Searchable
+
+      def search(opts={})
+        params = opts.slice(*valid_search_params)
+
+        connection.get("#{endpoint}/search", params)
+      end
+
+    end
+  end
+end

data/lib/desk/api/topics.rb

@@ -0,0 +1,25 @@
+require 'active_support/core_ext/hash'
+require 'desk/api/modules/listable'
+require 'desk/api/modules/creatable'
+require 'desk/api/modules/deletable'
+require 'desk/topic'
+
+module Desk
+  module Api
+    class Topics
+
+      include Desk::Api::Listable
+      include Desk::Api::Creatable
+      include Desk::Api::Deletable
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection)
+        @connection = connection
+        @endpoint = "topics"
+        @return_class = Desk::Topic
+      end
+
+    end
+  end
+end

data/lib/desk/api/translations.rb

@@ -0,0 +1,24 @@
+require 'desk/api/modules/listable'
+require 'desk/api/modules/creatable'
+require 'desk/translation'
+
+module Desk
+  module Api
+    class Translations
+
+      include Desk::Api::Listable
+      include Desk::Api::Creatable
+
+      attr_reader :connection, :endpoint, :return_class
+
+      def initialize(connection, parent)
+        @connection = connection
+        raise ArgumentError unless parent
+        @parent = parent
+        @endpoint = "#{parent.endpoint}/translations"
+        @return_class = Desk::Translation
+      end
+
+    end
+  end
+end

data/lib/desk/article.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Article < Entity
+
+  end
+end

data/lib/desk/case.rb

@@ -0,0 +1,7 @@
+require 'desk/entity'
+
+module Desk
+  class Case < Entity
+
+  end
+end