freshdesk-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1584f2235f86a34fcd3f791c1d2ef78892479c1
+  data.tar.gz: 91844236f68ad72c84d7d2a28b15093f35106373
+SHA512:
+  metadata.gz: d446b7163e438fe0ede04ea6b6953e5368b122ffba0f50b4335d02d084b082b2a8db9cc30d674ed4b0589a9588bdc78d32a381144f7c5cf746be207dfdd5d19f
+  data.tar.gz: 6d4d370036bd56ebbc6ff86b1ee6f7d4779771cef79e5a0fc2e3511d044be344a3517c811057f1b7d12dd8677b898905231f4e42959606715a1b8d8271ad2b43

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at akira@omise.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 akira
+
+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,104 @@
+# A Ruby API client for Freshdesk API v2
+
+[![Gem Version](https://badge.fury.io/rb/freshdesk-ruby.svg)](https://badge.fury.io/rb/freshdesk-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "freshdesk-ruby"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freshdesk-ruby
+
+## Usage
+
+A Ruby API client that interfaces with freshdesk.com web service. This client supports regular CRUD operation
+
+It supports following:
+
+- [Tickets](https://developer.freshdesk.com/api/#tickets)
+
+[freshdesk API reference](https://developer.freshdesk.com/api/)
+
+Currently I needed this library to support Tickets APIs to use this api client on a project. I am gonna update with other API supports later. And collaborators are welcome :)
+
+```ruby
+require "freshdesk-ruby"
+
+Freshdesk.domain = "replace with your domain"
+Freshdesk.user_name_or_api_key = "replace with your api key"
+Freshdesk.password_or_x = "X"
+
+# creates a ticket
+params = {
+  status: 2,
+  priority: 1,
+  description: "test ticket creation with attachments",
+  subject: "new ticket sample #{Time.now}",
+  cc_emails: ["test+1@example.com"],
+  email: "test@example.com",
+}
+Freshdesk::Ticket.create_a_ticket(params: params)
+
+# returns a ticket
+res = Freshdesk::Ticket.view_a_ticket(id: 19)
+# Freshdesk::Ticket.singleton_methods(false) return RestClient::Response instance
+res.class.name
+# => RestClient::Response
+
+res.code
+# => 200
+
+response_hash = JSON.parse(res.body)
+# => {"cc_emails"=>[], "fwd_emails"=>[], "reply_cc_emails"=>[], "fr_escalated"=>false, "spam"=>false, "email_config_id"=>nil, "group_id"=>nil, "priority"=>1, "requester_id"=>27000314885, "responder_id"=>nil, "source"=>2, "company_id"=>nil, "status"=>2, "subject"=>"new ticket sample 2017-04-06 16:07:20 +0900", "to_emails"=>nil, "product_id"=>nil, "id"=>19, "type"=>nil, "due_by"=>"2017-05-26T09:00:00Z", "fr_due_by"=>"2017-04-07T04:00:00Z", "is_escalated"=>false, "description"=>"<div>test ticket creation with attachments</div>", "description_text"=>"test ticket creation with attachments", "custom_fields"=>{"subcategory"=>nil, "category"=>nil, "featurecomponent"=>nil, "apiplugin"=>nil, "account_country"=>nil, "solution"=>nil}, "created_at"=>"2017-04-06T06:06:42Z", "updated_at"=>"2017-04-06T09:11:32Z", "tags"=>[], "attachments"=>[]}
+
+# lists all tickets
+Freshdesk::Ticket.list_all_tickets
+
+# updates a ticket
+params = {
+  subject: "new ticket sample #{Time.now}",
+}
+Freshdesk::Ticket.update_a_ticket(id: 19, params: params)
+
+# deletes a ticket
+Freshdesk::Ticket.delete_a_ticket(id: 19)
+
+# restores a ticket
+Freshdesk::Ticket.restore_a_ticket(id: 19)
+
+# lists all ticket fields
+Freshdesk::Ticket.list_all_ticket_fields
+
+# lists all conversations of a ticket
+Freshdesk::Ticket.list_all_conversations_of_a_ticket(id: 19)
+
+# lists all time entries of a ticket
+Freshdesk::Ticket.list_all_time_entries_of_a_ticket(id: 19)
+
+# lists all satisfaction ratings of a ticket
+Freshdesk::Ticket.list_all_satisfaction_ratings_of_a_ticket(ticket_id: 1)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akinrt/freshdesk-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freshdesk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/freshdesk.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshdesk/version'
+
+Gem::Specification.new do |s|
+  s.name          = "freshdesk-ruby"
+  s.version       = Freshdesk::VERSION
+  s.authors       = ["Akira Narita"]
+  s.email         = ["aki.d.sc@gmail.com"]
+  s.required_ruby_version     = ">= 2.2.2"
+  s.required_rubygems_version = ">= 1.8.11"
+
+  s.summary       = %q{A Ruby API client for Freshdesk API v2}
+  s.description   = %q{A Ruby API client for Freshdesk API v2}
+  s.homepage      = "https://github.com/akinrt/freshdesk-ruby"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.14"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "json", "~> 2.0.3"
+  s.add_development_dependency "rest-client", "~> 2.0.1"
+end

data/lib/freshdesk.rb

@@ -0,0 +1,8 @@
+require "freshdesk/version"
+require "freshdesk/config"
+require "freshdesk/freshdesk_object"
+require "freshdesk/resource"
+require "freshdesk/ticket"
+
+module Freshdesk
+end

data/lib/freshdesk/config.rb

@@ -0,0 +1,25 @@
+module Freshdesk
+  class << self
+    attr_accessor :domain, :user_name_or_api_key, :password_or_x, :api_version
+
+    def domain
+      get_key :domain
+    end
+
+    def user_name_or_api_key
+      get_key :user_name_or_api_key
+    end
+
+    def password_or_x
+      get_key :password_or_x
+    end
+
+    def api_version
+      "v2"
+    end
+
+    def get_key(key)
+      instance_variable_get("@#{key}") || raise("Set Freshdesk.#{key} to use this feature")
+    end
+  end
+end

data/lib/freshdesk/freshdesk_object.rb

@@ -0,0 +1,13 @@
+module Freshdesk
+  class FreshdeskObject
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    attr_reader :endpoint
+
+    def resource(params: {}, id: nil)
+      Freshdesk::Resource.new(endpoint, params, id)
+    end
+  end
+end

data/lib/freshdesk/resource.rb

@@ -0,0 +1,65 @@
+require "rest-client"
+require "json"
+
+module Freshdesk
+  class Resource
+    def initialize(endpoint, params = {}, id = nil)
+      @endpoint             = endpoint
+      @params               = params
+      @id                   = id
+      @domain               = Freshdesk.domain
+      @user_name_or_api_key = Freshdesk.user_name_or_api_key
+      @password_or_x        = Freshdesk.password_or_x
+      @api_version          = Freshdesk.api_version
+
+      @resource ||= RestClient::Resource.new(
+        api_url,
+        @user_name_or_api_key,
+        @password_or_x
+      )
+    end
+
+    attr_reader :endpoint, :params
+
+    def api_url
+      "https://#{@domain}.freshdesk.com/api/#{@api_version}#{@endpoint}"
+    end
+
+    def json_payload
+      @params.to_json
+    end
+
+    def post
+      @resource.post(json_payload, content_type: "application/json")
+    rescue RestClient::Exception => e
+      raise e, api_error_message(e)
+    end
+
+    def get
+      @resource.get(accept: "application/json")
+    rescue RestClient::Exception => e
+      raise e, api_error_message(e)
+    end
+
+    def delete
+      @resource.delete(accept: "application/json")
+    rescue RestClient::Exception => e
+      raise e, api_error_message(e)
+    end
+
+    def put
+      @resource.put(json_payload, content_type: "application/json")
+    rescue RestClient::Exception => e
+      raise e, api_error_message(e)
+    end
+
+    private
+
+    def api_error_message(e)
+      "API Error: Your request is not successful." \
+      "If you are not able to debug this error properly, mail us at support@freshdesk.com with the follwing X-Request-Id" \
+      "X-Request-Id : #{e.response.headers[:x_request_id]}" \
+      "Response Code: #{e.response.code} Response Body: #{e.response.body}"
+    end
+  end
+end

data/lib/freshdesk/ticket.rb

@@ -0,0 +1,49 @@
+module Freshdesk
+  class Ticket < FreshdeskObject
+    class << self
+      def create_a_ticket(params: {})
+        new("/tickets").resource(params: params).post
+      end
+
+      def create_an_outbound_email(params: {})
+        new("/tickets/outbound_email").resource(params: params).post
+      end
+
+      def view_a_ticket(id:, query: "")
+        new("/tickets/#{id}#{query}").resource(id: id).get
+      end
+
+      def list_all_tickets(query: "")
+        new("/tickets#{query}").resource.get
+      end
+
+      def update_a_ticket(id:, params: {})
+        new("/tickets/#{id}").resource(id: id, params: params).put
+      end
+
+      def delete_a_ticket(id:)
+        new("/tickets/#{id}").resource(id: id).delete
+      end
+
+      def restore_a_ticket(id:)
+        new("/tickets/#{id}/restore").resource(id: id).put
+      end
+
+      def list_all_ticket_fields
+        new("/ticket_fields").resource.get
+      end
+
+      def list_all_conversations_of_a_ticket(id:)
+        new("/tickets/#{id}/conversations").resource(id: id).get
+      end
+
+      def list_all_time_entries_of_a_ticket(id:)
+        new("/tickets/#{id}/time_entries").resource(id: id).get
+      end
+
+      def list_all_satisfaction_ratings_of_a_ticket(ticket_id:)
+        new("/tickets/#{ticket_id}/satisfaction_ratings").resource.get
+      end
+    end
+  end
+end

data/lib/freshdesk/version.rb

@@ -0,0 +1,3 @@
+module Freshdesk
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: freshdesk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Narita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: A Ruby API client for Freshdesk API v2
+email:
+- aki.d.sc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freshdesk.gemspec
+- lib/freshdesk.rb
+- lib/freshdesk/config.rb
+- lib/freshdesk/freshdesk_object.rb
+- lib/freshdesk/resource.rb
+- lib/freshdesk/ticket.rb
+- lib/freshdesk/version.rb
+homepage: https://github.com/akinrt/freshdesk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: A Ruby API client for Freshdesk API v2
+test_files: []