rottendesk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb3b1b0daccdc6e0dc9f3ef7318e5e1e79081e85
+  data.tar.gz: 60ded24611b0a97d20ace854bfcdd2995ff9d3ea
+SHA512:
+  metadata.gz: 8107158d3c3816dc152ba984311b70eff08fc5079bc6336fc74504e3172214a03783c4081d25c01efc242170c688c43ada15f3696b0faa4a1bd2a31a71973fa8
+  data.tar.gz: 5ac20af27b68e20b213a8bbe18724d7eb6dceae2e8c1ca9489c542552e37799b7ee2b161937454175172a4a6ca35160de0253e9c34b8dc62f25e4a28616a8ff3

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Abdulsattar Mohammed
+
+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,51 @@
+# Rottendesk
+
+Ruby client for [Freshdesk](https://freshdesk.com) that uses the [JSON API](http://freshdesk.com/api) of Freshdesk.
+
+[![Code Climate](https://codeclimate.com/github/abdulsattar/rottendesk/badges/gpa.svg)](https://codeclimate.com/github/abdulsattar/rottendesk)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rottendesk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rottendesk
+
+## Usage
+
+``` ruby
+rottendesk = Rottendesk::App.new('domain.freshdesk.com', 'username/key', 'password')
+
+rottendesk.User.find(<user_id>)
+=> #<Rottendesk::User:0x007f1d9935d438
+  @active=true,
+  @name = "Eddard Stark"
+  @address="1 Winterfell"
+  ...
+
+rottendesk.User.where(options)
+=> [#<Rottendesk::User:0x007f1d9935d438
+  @active=true,
+  @name = "Eddard Stark"
+  @address="1 Winterfell"
+  ...,
+  #<Rottendesk::User:0x007f1d9935d438
+  @active=true,
+  @name = "Bran Stark"
+  @address="2 Tree"]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/abdulsattar/rottendesk/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 @@
+require "bundler/gem_tasks"

data/lib/rottendesk/app.rb

@@ -0,0 +1,32 @@
+require 'logger'
+
+module Rottendesk
+  class App
+    attr_accessor :url, :username, :password, :ssl
+
+    def initialize(url, username, password = 'X', ssl = false)
+      @url = url
+      @username = username
+      @password = password
+      @ssl = ssl
+    end
+
+    def client
+      @client ||= Client.new("http#{ssl ? '' : 's'}://#{username}:#{password}@#{url}")
+    end
+
+
+    models = [User, Ticket]
+
+    models.each do |m|
+      class_eval %Q<
+        def #{m.short_name}
+          @#{m.short_name.downcase} ||= begin
+                                          #{m}.app = self
+                                          #{m}
+                                        end
+        end
+      >
+    end
+  end
+end

data/lib/rottendesk/client.rb

@@ -0,0 +1,46 @@
+module Rottendesk
+  class Client
+
+    def initialize(url)
+      @rest_client = RestClient::Resource.new(url)
+    end
+
+    def get(url, options = {})
+      request(url, options.merge(method: :get))
+    end
+
+    def post(url, body,  options = {})
+      request(url, options.merge(method: :post, body: body))
+    end
+
+    def patch(url, body, options = {})
+      request(url, options.merge(method: :patch, body: body))
+    end
+
+    def delete(url, options = {})
+      request(url, options.merge(method: :delete))
+    end
+
+    def request(url, options = {})
+      defaults = {
+        method: :get,
+        content_type: :json,
+        accept: :json
+      }
+      options = defaults.merge(options)
+
+      Rottendesk.logger.info "Rottendesk: #{options[:method].upcase} /#{url}.json with #{options.except(:method)}"
+
+      args = [options[:method], options[:body], options.except(:method, :body)].compact
+      response = @rest_client[url + '.json'].send(*args)
+
+      Rottendesk.logger.info "Rottendesk: #{response.code}"
+
+      response
+
+    rescue RestClient::Exception => e
+      Rottendesk.logger.warn "Rottendesk: #{e.response.code}"
+      raise e
+    end
+  end
+end

data/lib/rottendesk/helpers/class.rb

@@ -0,0 +1,5 @@
+class Class
+  def short_name
+    name.split('::').last
+  end
+end

data/lib/rottendesk/helpers/hash.rb

@@ -0,0 +1,16 @@
+class Hash
+  def compact
+    select do |_, v|
+      !v.nil?
+    end
+  end
+
+  def except(*keys)
+    dup.except!(*keys)
+  end
+
+  def except!(*keys)
+    keys.each { |key| delete(key) }
+    self
+  end
+end

data/lib/rottendesk/models/model.rb

@@ -0,0 +1,127 @@
+require 'rest_client'
+require 'json'
+
+module Rottendesk
+  class Model
+
+    def initialize(attrs = {})
+      attrs.each do |k,v|
+        self.send("#{k}=", v) if respond_to? "#{k}="
+      end
+    end
+
+    def persisted?
+      !self.id.nil?
+    end
+
+    def save
+      persisted? ? update : create_new
+    end
+
+    def update
+    end
+
+    def to_h
+      fields.reduce({}){|h, f| h[f] = self.send(f); h}.compact
+    end
+
+    def errors
+      @errors
+    end
+
+    def valid?
+      errors.nil? || errors.empty?
+    end
+
+    def from_json(json)
+      json = JSON.parse(json) if json.is_a? String
+      json = json[json_key] if json[json_key]
+      fields.each do |f|
+        self.instance_variable_set("@#{f}", json[f.to_s])
+      end
+      self
+    end
+
+    def fields
+      self.class.fields
+    end
+
+    protected
+    def create_new
+      json = {json_key => to_h}.to_json
+      response = client.post(endpoint, json)
+      self.from_json response
+    rescue RestClient::UnprocessableEntity => ex
+      @errors = Hash[JSON.parse(ex.response)]
+      self
+    end
+
+    def endpoint
+      self.class.get_endpoint
+    end
+
+    def json_key
+      self.class.get_json_key
+    end
+
+    def client
+      self.class.app.client
+    end
+
+    class << self
+
+      attr_accessor :app
+
+      def create(attrs = {})
+        model = self.new(attrs)
+        model.save
+      end
+
+      def find(id)
+        parse(app.client.get("#{@endpoint}/#{id}"))
+      end
+
+      def where(filters = {})
+        parse(app.client.get(@endpoint, params: filters))
+      end
+
+      def parse(json)
+        remote_fields = JSON.parse(json)
+
+        if remote_fields.is_a? Array
+          remote_fields.map{|f| self.new.from_json(f)}
+        else
+          self.new.from_json(remote_fields)
+        end
+      end
+
+      def field(field, options = {})
+        @_fields ||= []
+        @_fields << field
+
+        attr_reader field
+        attr_writer field unless options[:readonly]
+      end
+
+      def fields
+        @_fields
+      end
+
+      def endpoint(endpoint)
+        @endpoint ||= endpoint
+      end
+
+      def json_key(key)
+        @json_key = key
+      end
+
+      def get_endpoint
+        @endpoint
+      end
+
+      def get_json_key
+        @json_key
+      end
+    end
+  end
+end

data/lib/rottendesk/models/ticket.rb

@@ -0,0 +1,29 @@
+module Rottendesk
+  class Ticket < Model
+
+    endpoint "helpdesk/tickets"
+    json_key "helpdesk_ticket"
+
+    field :id, readonly: true
+
+    field :display_id, readonly: true
+    field :email
+    field :requester_id
+    field :subject
+    field :description
+    field :description_html
+    field :status
+    field :priority
+    field :source
+    field :deleted
+    field :spam
+    field :responder_id
+    field :group_id
+    field :ticket_type
+    field :cc_email
+    field :email_config_id
+    field :isescalated
+    field :due_by
+    field :attachments, readonly: true
+  end
+end

data/lib/rottendesk/models/user.rb

@@ -0,0 +1,35 @@
+module Rottendesk
+  class User < Model
+
+    endpoint "contacts"
+    json_key "user"
+
+    field :id, readonly: true
+
+    field :name
+    field :email
+    field :address
+    field :description
+    field :job_title
+    field :twitter_id
+    field :fb_profile_if
+    field :phone
+    field :mobile
+    field :language
+    field :time_zone
+    field :customer_id
+    field :deleted
+    field :helpdesk_agent, readonly: true
+    field :active, readonly: true
+
+    class << self
+      def where(filters = {})
+        filters[:query] = "phone is #{filters.delete(:phone)}" if filters[:phone]
+        filters[:query] = "mobile is #{filters.delete(:mobile)}" if filters[:mobile]
+        filters[:query] = "email is #{filters.delete(:email)}" if filters[:email]
+        super(filters)
+      end
+    end
+
+  end
+end

data/lib/rottendesk/version.rb

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

data/lib/rottendesk.rb

@@ -0,0 +1,19 @@
+require "rottendesk/version"
+
+require 'rottendesk/helpers/class'
+require 'rottendesk/helpers/hash'
+
+require 'rottendesk/models/model'
+require 'rottendesk/models/ticket'
+require 'rottendesk/models/user'
+
+require 'rottendesk/client'
+require 'rottendesk/app'
+
+module Rottendesk
+  class << self
+    attr_accessor :logger
+  end
+end
+
+Rottendesk.logger = Logger.new $stdout

data/rottendesk.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rottendesk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rottendesk"
+  spec.version       = Rottendesk::VERSION
+  spec.authors       = ["Abdulsattar Mohammed"]
+  spec.email         = ["asattar.md@gmail.com"]
+  spec.summary       = %q{Ruby client for Freshdesk}
+  spec.description   = %q{Ruby client for Freshdesk that uses the JSON API of Freshdesk}
+  spec.homepage      = ""
+  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_runtime_dependency 'rest_client'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rottendesk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abdulsattar Mohammed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: 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'
+description: Ruby client for Freshdesk that uses the JSON API of Freshdesk
+email:
+- asattar.md@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rottendesk.rb
+- lib/rottendesk/app.rb
+- lib/rottendesk/client.rb
+- lib/rottendesk/helpers/class.rb
+- lib/rottendesk/helpers/hash.rb
+- lib/rottendesk/models/model.rb
+- lib/rottendesk/models/ticket.rb
+- lib/rottendesk/models/user.rb
+- lib/rottendesk/version.rb
+- rottendesk.gemspec
+homepage: ''
+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: Ruby client for Freshdesk
+test_files: []
+has_rdoc: