limdesk_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98a9417eaadaf56f00c999cd56a4f54d86c82d15
+  data.tar.gz: fbccda463576a535adab7f5e0de327e7984202f9
+SHA512:
+  metadata.gz: 1cfb8ffaade21c04901a4bd485c6c1ccfe7d698783fd91524ec3af437b1d6b65dbbc676854d3371212bee0dbcb02d2326df242f125fae655c70172abd2834990
+  data.tar.gz: f8a6610416d9eed8347a55301e033730b94c14e98e0ded7e24bfbc0dfe0e05480c677e234b9de788f7ff5c00926fb5bba1916b3e95a47f13bacf0ec94bf6d864

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in limdesk_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Grzegorz Siehień Limtel Sp. z o.o.
+
+MIT License
+
+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,121 @@
+# LimdeskApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'limdesk_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limdesk_api
+
+## Usage
+
+This gem will allow you to interact with Limdesk API. [Limdesk.com](http://limdesk.com) is a lightweight, multichannel customer support solution. 
+
+API is available to free and premium users. You can generate your APIKEY in Settings/Integration/API section. 
+
+This gem wrappes Limdesk API into OpenStruct (RecursiveOpenStruct) objects. For more information about API check the [official docs](http://help.limdesk.com/en/category/458/API_documentation). Current API covers basic, most common actions. More advanced version is currenty under development.
+
+#### Connecting to API
+
+```ruby
+LimdeskApi.configure do |lim|
+  lim.key = '<YOUR API KEY>'
+  lim.version = 1
+end
+```
+
+#### Tickets
+
+```ruby
+
+tickets = LimdeskApi::Ticket.all
+
+tickets.count
+63
+
+tickets.first.title
+"Hello World"
+
+ticket = LimdeskApi::Ticket.get(44)
+
+ticket.title
+"Hello"
+
+ticket.client.name
+"John Smith"
+
+ticket.answer(content: 'this is a private comment', answer_type: :priv)
+ticket.answer(content: 'dear customer, it is solved', answer_type: :pub)
+
+ticket.close(content: 'its solved', type: :resolved)
+ticket.reopen
+ticket.close(content: 'spam', type: :rejected)
+
+ticket2 = LimdeskApi::Ticket.create title: "a ticket", content: "client's probem", reported_by: :mail, client_id: -1
+                                    
+# reported_by can be mail, phone, other, chat
+# client_id => -1 means "new anonymous clinet"
+                                    
+ticket2.ok?
+true
+ticket2.title
+"a ticket"
+							
+```
+
+#### Activities
+
+```ruby
+
+acts = LimdeskApi::Activity.all
+
+act = LimdeskApi::Activity.create( :content=>"client has logged into website",
+                                   :client_id=>55 )
+```
+
+
+#### Clients
+
+
+```ruby
+
+cls = LimdeskApi::Client.all
+
+cls.first.name
+"John Smith"
+
+client = LimdeskApi::Client.create( 	:name =>"John Smith", 
+                  							    	:nippesel =>"15012406496",
+                  							    	:phone =>"223111789",
+                  							    	:email =>"email@example.com",
+                  							    	:adress =>"Plain Street 149 85-058 Warsaw" )
+client.ok?
+true
+
+client.delete!
+true
+
+client2 = LimdeskApi::Client.get(55)
+client2.contacts.first
+
+```
+
+## TODO
+
+* tests
+* lazy loading
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/limdesk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/limdesk_api.rb

@@ -0,0 +1,129 @@
+require "faraday"
+require "recursive_open_struct"
+require "faraday_middleware"
+require "json"
+require "limdesk_api/version"
+require "limdesk_api/client"
+require "limdesk_api/activity"
+require "limdesk_api/ticket"
+
+module LimdeskApi
+
+  ENDPOINT = 'https://cloud.limdesk.com'
+
+  KNOWN_OBJS = {
+    ticket: :tickets,
+    activity: :activities,
+    client: :clients,
+  }
+
+  def self.configure
+    yield self
+    @connection = Faraday.new(:url => ENDPOINT) do |faraday|
+      faraday.response :json, :content_type => /\bjson$/
+      faraday.adapter Faraday.default_adapter 
+      faraday.use Faraday::Response::Logger if @debug
+    end
+    @prefix = "/api/v#{@version}"
+    return self
+  end
+
+  def self.key=(key)
+    return @key = key
+  end
+
+  def self.version=(version)
+    return @version = version
+  end
+
+  def self.debug=(debug)
+    return @debug = debug
+  end
+
+  def self.get_one(params)
+    resp = @connection.get do |req|
+      req.url "#{@prefix}/#{LimdeskApi::KNOWN_OBJS[params[:object]]}/#{params[:id]}"
+      req.params[:key] = @key
+    end
+    case resp.status
+    when 200
+      raise "LimdeskApiError" unless resp.body.kind_of?(Hash) && resp.body['status'] == "ok"
+      return nil if resp.body[params[:object].to_s].nil?
+      return resp.body[params[:object].to_s]
+    when 404
+      return nil
+    else
+      raise "LimdeskApiErrorFatal"
+    end
+  end
+
+  def self.get_many(params)
+    resp = @connection.get do |req|
+      req.url "#{@prefix}/#{LimdeskApi::KNOWN_OBJS[params[:object]]}"
+      req.params[:key] = @key
+      req.params[:page] = params[:page] if params[:page].to_i > 0
+    end
+    case resp.status
+    when 200
+      raise "LimdeskApiError" unless resp.body.kind_of?(Hash) && resp.body['status'] == "ok"
+      raise "LimdeskApiError" unless resp.body['page'] && resp.body['total_pages']
+      raise "LimdeskApiError" unless resp.body[LimdeskApi::KNOWN_OBJS[params[:object]].to_s]
+      return {  :page=>resp.body['page'],
+                :total_pages=>resp.body['total_pages'],
+                :objects=>resp.body[LimdeskApi::KNOWN_OBJS[params[:object]].to_s] }
+    else
+      raise "LimdeskApiErrorFatal"
+    end
+  end
+
+  def self.create(params)
+    resp = @connection.post do |req|
+      req.url "#{@prefix}/#{LimdeskApi::KNOWN_OBJS[params[:object]]}"
+      req.params[:key] = @key
+      req.body = params[:params].to_json
+    end
+    case resp.status
+    when 200
+      raise "LimdeskApiError" unless resp.body.kind_of?(Hash) && resp.body['status']
+      return { error: true, msg: resp.body['msg'] } if resp.body['status'] == "error"
+      raise "LimdeskApiError" if resp.body[params[:object].to_s].nil?
+      return resp.body[params[:object].to_s]
+    else
+      raise "LimdeskApiErrorFatal"
+    end
+  end
+
+  def self.put(params)
+    self.update(:put, params)
+  end
+
+  def self.post_simple(params)
+    self.update(:post, params)
+  end
+
+  def self.delete(params)
+    self.update(:delete, params)
+  end
+
+  def self.update(method, params)
+    url = "#{@prefix}/#{LimdeskApi::KNOWN_OBJS[params[:object]]}/#{params[:id]}"
+    url += "/#{params[:action]}" if params[:action]
+    resp = @connection.send(method) do |req|
+      req.url url
+      req.params[:key] = @key
+      req.body = params[:params].to_json
+    end
+    case resp.status
+    when 200
+      raise "LimdeskApiError" unless resp.body.kind_of?(Hash) && resp.body['status']
+      if resp.body['status'] == "ok"
+        return { error: false }
+      else
+        return { error: true, msg: resp.body['msg'] }
+      end
+    else
+      raise "LimdeskApiErrorFatal"
+    end
+  end
+
+end

data/lib/limdesk_api/activity.rb

@@ -0,0 +1,31 @@
+module LimdeskApi
+
+  class Activity < RecursiveOpenStruct
+
+    def self.create(params)
+      response = LimdeskApi.create(:object=>:activity , :params=>params)
+      Activity.new response
+    end
+
+    def self.all
+      query_options = { page: 1, object: :activity }
+      results = {}
+      activities = []
+      loop do
+        unless results[:total_pages].nil?
+          raise StopIteration if results[:total_pages] == results[:page]
+        end
+        results = LimdeskApi.get_many(query_options)
+        query_options[:page] += 1
+        activities+=results[:objects].map { |x| Activity.new x }
+      end
+      activities
+    end
+
+    def ok?
+      error == true ? false : true
+    end
+
+  end
+  
+end

data/lib/limdesk_api/client.rb

@@ -0,0 +1,44 @@
+module LimdeskApi
+
+  class Client < RecursiveOpenStruct
+
+    def self.get(id)
+      response = LimdeskApi.get_one(:object=>:client, :id=>id)
+      response ? Client.new(response) : nil
+    end
+
+    def self.create(params)
+      response = LimdeskApi.create(:object=>:client, :params=>params)
+      Client.new response
+    end
+
+    def self.all
+      query_options = { page: 1, object: :client }
+      results = {}
+      clients = []
+      loop do
+        unless results[:total_pages].nil?
+          raise StopIteration if results[:total_pages] == results[:page]
+        end
+        results = LimdeskApi.get_many(query_options)
+        query_options[:page] += 1
+        clients+=results[:objects].map { |x| Client.new x }
+      end
+      clients
+    end
+
+    def ok?
+      error == true ? false : true
+    end
+
+    def refresh!
+      self.marshal_load(Client.get(self['id']).marshal_dump)
+    end
+
+    def delete!
+      response = LimdeskApi.delete( id: self.id, object: :client )
+      return not(response[:error])
+    end
+
+  end
+end

data/lib/limdesk_api/ticket.rb

@@ -0,0 +1,89 @@
+module LimdeskApi
+
+  class Ticket < RecursiveOpenStruct
+
+    CLOSE_TYPES = {
+      rejected: 2,
+      resolved: 1 
+    }
+
+    MEDIA_TYPES = {
+      mail: 1,
+      chat: 2,
+      phone: 3,
+      other: 4,   
+    }
+
+    ANSWER_TYPES = {
+      pub: 0,
+      priv: 1
+    }
+
+    def self.get(no)
+      response = LimdeskApi.get_one(:object=>:ticket, :id=>no)
+      response ? Ticket.new(response) : nil
+    end
+
+    def self.create(params)
+      raise "BadMediaType" unless Ticket::MEDIA_TYPES.keys.include?(params[:reported_by])
+      params["reportedBy"] = Ticket::MEDIA_TYPES[params.delete(:reported_by)]
+      response = LimdeskApi.create(:object=>:ticket, :params=>params)
+      Ticket.new response
+    end
+
+    def self.all
+      query_options = { page: 1, object: :ticket }
+      results = {}
+      tickets = []
+      loop do
+        unless results[:total_pages].nil?
+          raise StopIteration if results[:total_pages] == results[:page]
+        end
+        results = LimdeskApi.get_many(query_options)
+        query_options[:page] += 1
+        tickets+=results[:objects].map { |x| Ticket.new x }
+      end
+      tickets
+    end
+
+    def ok?
+      error == true ? false : true
+    end
+
+    def refresh!
+      self.marshal_load(Ticket.get(self['number']).marshal_dump)
+    end
+
+    def close(params)
+      raise "BadCloseType" unless Ticket::CLOSE_TYPES.keys.include?(params[:type])
+      raise "NoContentGiven" unless params[:content]
+      response = LimdeskApi.put( id: self.number,
+                              object: :ticket,
+                              action: :close,
+                              params: { content: params[:content], type: Ticket::CLOSE_TYPES[params[:type]] } )
+      refresh!
+      return not(response[:error])
+    end
+
+    def reopen
+      response = LimdeskApi.put( id: self.number,
+                              object: :ticket,
+                              action: :reopen,
+                              params: {} )
+      refresh!
+      return not(response[:error])
+    end  
+
+    def answer(params)
+      raise "BadAnswerType" unless Ticket::ANSWER_TYPES.keys.include?(params[:answer_type])
+      params["type"] = Ticket::ANSWER_TYPES[params.delete(:answer_type)]
+      response = LimdeskApi.post_simple(  id: self.number,
+                                       object: :ticket,
+                                       action: :answer,
+                                       params: params )
+      refresh!      
+      return not(response[:error])
+    end
+
+  end
+end

data/lib/limdesk_api/version.rb

@@ -0,0 +1,3 @@
+module LimdeskApi
+  VERSION = "0.0.1"
+end

data/limdesk_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'limdesk_api/version'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "limdesk_api"
+  spec.version       = LimdeskApi::VERSION
+  spec.authors       = ["Grzegorz Siehień"]
+  spec.email         = ["grzegorz.siehien@limtel.com"]
+  spec.summary       = %q{Gem for interacting with Limdesk.com}
+  spec.description   = %q{Limdesk.com is a multichannel, web-based customer support solution. This gem lets you integrate your software using Limdesk's API.}
+  spec.homepage      = "https://www.limdesk.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_dependency 'faraday', '~> 0.9.0', '>= 0.9.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.1', '>= 0.9.0'
+  spec.add_dependency 'recursive-open-struct', '~> 0.5.0', '>= 0.5.0'
+  spec.add_dependency 'json', '~> 1.8.1', '>= 1.8.0'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: limdesk_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Grzegorz Siehień
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Limdesk.com is a multichannel, web-based customer support solution. This
+  gem lets you integrate your software using Limdesk's API.
+email:
+- grzegorz.siehien@limtel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/limdesk_api.rb
+- lib/limdesk_api/activity.rb
+- lib/limdesk_api/client.rb
+- lib/limdesk_api/ticket.rb
+- lib/limdesk_api/version.rb
+- limdesk_api.gemspec
+homepage: https://www.limdesk.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for interacting with Limdesk.com
+test_files: []