freshdesk-ruby 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: a1584f2235f86a34fcd3f791c1d2ef78892479c1
4
+ data.tar.gz: 91844236f68ad72c84d7d2a28b15093f35106373
5
+ SHA512:
6
+ metadata.gz: d446b7163e438fe0ede04ea6b6953e5368b122ffba0f50b4335d02d084b082b2a8db9cc30d674ed4b0589a9588bdc78d32a381144f7c5cf746be207dfdd5d19f
7
+ data.tar.gz: 6d4d370036bd56ebbc6ff86b1ee6f7d4779771cef79e5a0fc2e3511d044be344a3517c811057f1b7d12dd8677b898905231f4e42959606715a1b8d8271ad2b43
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.2.6
5
+ before_install: gem install bundler -v 1.14.6
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at akira@omise.co. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in freshdesk.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 akira
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,104 @@
1
+ # A Ruby API client for Freshdesk API v2
2
+
3
+ [![Gem Version](https://badge.fury.io/rb/freshdesk-ruby.svg)](https://badge.fury.io/rb/freshdesk-ruby)
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem "freshdesk-ruby"
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install freshdesk-ruby
20
+
21
+ ## Usage
22
+
23
+ A Ruby API client that interfaces with freshdesk.com web service. This client supports regular CRUD operation
24
+
25
+ It supports following:
26
+
27
+ - [Tickets](https://developer.freshdesk.com/api/#tickets)
28
+
29
+ [freshdesk API reference](https://developer.freshdesk.com/api/)
30
+
31
+ 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 :)
32
+
33
+ ```ruby
34
+ require "freshdesk-ruby"
35
+
36
+ Freshdesk.domain = "replace with your domain"
37
+ Freshdesk.user_name_or_api_key = "replace with your api key"
38
+ Freshdesk.password_or_x = "X"
39
+
40
+ # creates a ticket
41
+ params = {
42
+ status: 2,
43
+ priority: 1,
44
+ description: "test ticket creation with attachments",
45
+ subject: "new ticket sample #{Time.now}",
46
+ cc_emails: ["test+1@example.com"],
47
+ email: "test@example.com",
48
+ }
49
+ Freshdesk::Ticket.create_a_ticket(params: params)
50
+
51
+ # returns a ticket
52
+ res = Freshdesk::Ticket.view_a_ticket(id: 19)
53
+ # Freshdesk::Ticket.singleton_methods(false) return RestClient::Response instance
54
+ res.class.name
55
+ # => RestClient::Response
56
+
57
+ res.code
58
+ # => 200
59
+
60
+ response_hash = JSON.parse(res.body)
61
+ # => {"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"=>[]}
62
+
63
+ # lists all tickets
64
+ Freshdesk::Ticket.list_all_tickets
65
+
66
+ # updates a ticket
67
+ params = {
68
+ subject: "new ticket sample #{Time.now}",
69
+ }
70
+ Freshdesk::Ticket.update_a_ticket(id: 19, params: params)
71
+
72
+ # deletes a ticket
73
+ Freshdesk::Ticket.delete_a_ticket(id: 19)
74
+
75
+ # restores a ticket
76
+ Freshdesk::Ticket.restore_a_ticket(id: 19)
77
+
78
+ # lists all ticket fields
79
+ Freshdesk::Ticket.list_all_ticket_fields
80
+
81
+ # lists all conversations of a ticket
82
+ Freshdesk::Ticket.list_all_conversations_of_a_ticket(id: 19)
83
+
84
+ # lists all time entries of a ticket
85
+ Freshdesk::Ticket.list_all_time_entries_of_a_ticket(id: 19)
86
+
87
+ # lists all satisfaction ratings of a ticket
88
+ Freshdesk::Ticket.list_all_satisfaction_ratings_of_a_ticket(ticket_id: 1)
89
+ ```
90
+
91
+ ## Development
92
+
93
+ 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.
94
+
95
+ 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).
96
+
97
+ ## Contributing
98
+
99
+ 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.
100
+
101
+
102
+ ## License
103
+
104
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "freshdesk"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,32 @@
1
+ # -*- encoding: utf-8 -*-
2
+ # frozen_string_literal: true
3
+ lib = File.expand_path('../lib', __FILE__)
4
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
5
+ require 'freshdesk/version'
6
+
7
+ Gem::Specification.new do |s|
8
+ s.name = "freshdesk-ruby"
9
+ s.version = Freshdesk::VERSION
10
+ s.authors = ["Akira Narita"]
11
+ s.email = ["aki.d.sc@gmail.com"]
12
+ s.required_ruby_version = ">= 2.2.2"
13
+ s.required_rubygems_version = ">= 1.8.11"
14
+
15
+ s.summary = %q{A Ruby API client for Freshdesk API v2}
16
+ s.description = %q{A Ruby API client for Freshdesk API v2}
17
+ s.homepage = "https://github.com/akinrt/freshdesk-ruby"
18
+ s.license = "MIT"
19
+
20
+ s.files = `git ls-files -z`.split("\x0").reject do |f|
21
+ f.match(%r{^(test|spec|features)/})
22
+ end
23
+ s.bindir = "exe"
24
+ s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
25
+ s.require_paths = ["lib"]
26
+
27
+ s.add_development_dependency "bundler", "~> 1.14"
28
+ s.add_development_dependency "rake", "~> 10.0"
29
+ s.add_development_dependency "rspec", "~> 3.0"
30
+ s.add_development_dependency "json", "~> 2.0.3"
31
+ s.add_development_dependency "rest-client", "~> 2.0.1"
32
+ end
@@ -0,0 +1,8 @@
1
+ require "freshdesk/version"
2
+ require "freshdesk/config"
3
+ require "freshdesk/freshdesk_object"
4
+ require "freshdesk/resource"
5
+ require "freshdesk/ticket"
6
+
7
+ module Freshdesk
8
+ end
@@ -0,0 +1,25 @@
1
+ module Freshdesk
2
+ class << self
3
+ attr_accessor :domain, :user_name_or_api_key, :password_or_x, :api_version
4
+
5
+ def domain
6
+ get_key :domain
7
+ end
8
+
9
+ def user_name_or_api_key
10
+ get_key :user_name_or_api_key
11
+ end
12
+
13
+ def password_or_x
14
+ get_key :password_or_x
15
+ end
16
+
17
+ def api_version
18
+ "v2"
19
+ end
20
+
21
+ def get_key(key)
22
+ instance_variable_get("@#{key}") || raise("Set Freshdesk.#{key} to use this feature")
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,13 @@
1
+ module Freshdesk
2
+ class FreshdeskObject
3
+ def initialize(endpoint)
4
+ @endpoint = endpoint
5
+ end
6
+
7
+ attr_reader :endpoint
8
+
9
+ def resource(params: {}, id: nil)
10
+ Freshdesk::Resource.new(endpoint, params, id)
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,65 @@
1
+ require "rest-client"
2
+ require "json"
3
+
4
+ module Freshdesk
5
+ class Resource
6
+ def initialize(endpoint, params = {}, id = nil)
7
+ @endpoint = endpoint
8
+ @params = params
9
+ @id = id
10
+ @domain = Freshdesk.domain
11
+ @user_name_or_api_key = Freshdesk.user_name_or_api_key
12
+ @password_or_x = Freshdesk.password_or_x
13
+ @api_version = Freshdesk.api_version
14
+
15
+ @resource ||= RestClient::Resource.new(
16
+ api_url,
17
+ @user_name_or_api_key,
18
+ @password_or_x
19
+ )
20
+ end
21
+
22
+ attr_reader :endpoint, :params
23
+
24
+ def api_url
25
+ "https://#{@domain}.freshdesk.com/api/#{@api_version}#{@endpoint}"
26
+ end
27
+
28
+ def json_payload
29
+ @params.to_json
30
+ end
31
+
32
+ def post
33
+ @resource.post(json_payload, content_type: "application/json")
34
+ rescue RestClient::Exception => e
35
+ raise e, api_error_message(e)
36
+ end
37
+
38
+ def get
39
+ @resource.get(accept: "application/json")
40
+ rescue RestClient::Exception => e
41
+ raise e, api_error_message(e)
42
+ end
43
+
44
+ def delete
45
+ @resource.delete(accept: "application/json")
46
+ rescue RestClient::Exception => e
47
+ raise e, api_error_message(e)
48
+ end
49
+
50
+ def put
51
+ @resource.put(json_payload, content_type: "application/json")
52
+ rescue RestClient::Exception => e
53
+ raise e, api_error_message(e)
54
+ end
55
+
56
+ private
57
+
58
+ def api_error_message(e)
59
+ "API Error: Your request is not successful." \
60
+ "If you are not able to debug this error properly, mail us at support@freshdesk.com with the follwing X-Request-Id" \
61
+ "X-Request-Id : #{e.response.headers[:x_request_id]}" \
62
+ "Response Code: #{e.response.code} Response Body: #{e.response.body}"
63
+ end
64
+ end
65
+ end
@@ -0,0 +1,49 @@
1
+ module Freshdesk
2
+ class Ticket < FreshdeskObject
3
+ class << self
4
+ def create_a_ticket(params: {})
5
+ new("/tickets").resource(params: params).post
6
+ end
7
+
8
+ def create_an_outbound_email(params: {})
9
+ new("/tickets/outbound_email").resource(params: params).post
10
+ end
11
+
12
+ def view_a_ticket(id:, query: "")
13
+ new("/tickets/#{id}#{query}").resource(id: id).get
14
+ end
15
+
16
+ def list_all_tickets(query: "")
17
+ new("/tickets#{query}").resource.get
18
+ end
19
+
20
+ def update_a_ticket(id:, params: {})
21
+ new("/tickets/#{id}").resource(id: id, params: params).put
22
+ end
23
+
24
+ def delete_a_ticket(id:)
25
+ new("/tickets/#{id}").resource(id: id).delete
26
+ end
27
+
28
+ def restore_a_ticket(id:)
29
+ new("/tickets/#{id}/restore").resource(id: id).put
30
+ end
31
+
32
+ def list_all_ticket_fields
33
+ new("/ticket_fields").resource.get
34
+ end
35
+
36
+ def list_all_conversations_of_a_ticket(id:)
37
+ new("/tickets/#{id}/conversations").resource(id: id).get
38
+ end
39
+
40
+ def list_all_time_entries_of_a_ticket(id:)
41
+ new("/tickets/#{id}/time_entries").resource(id: id).get
42
+ end
43
+
44
+ def list_all_satisfaction_ratings_of_a_ticket(ticket_id:)
45
+ new("/tickets/#{ticket_id}/satisfaction_ratings").resource.get
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,3 @@
1
+ module Freshdesk
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,131 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: freshdesk-ruby
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Akira Narita
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-04-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: json
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 2.0.3
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 2.0.3
69
+ - !ruby/object:Gem::Dependency
70
+ name: rest-client
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 2.0.1
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 2.0.1
83
+ description: A Ruby API client for Freshdesk API v2
84
+ email:
85
+ - aki.d.sc@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - README.md
97
+ - Rakefile
98
+ - bin/console
99
+ - bin/setup
100
+ - freshdesk.gemspec
101
+ - lib/freshdesk.rb
102
+ - lib/freshdesk/config.rb
103
+ - lib/freshdesk/freshdesk_object.rb
104
+ - lib/freshdesk/resource.rb
105
+ - lib/freshdesk/ticket.rb
106
+ - lib/freshdesk/version.rb
107
+ homepage: https://github.com/akinrt/freshdesk-ruby
108
+ licenses:
109
+ - MIT
110
+ metadata: {}
111
+ post_install_message:
112
+ rdoc_options: []
113
+ require_paths:
114
+ - lib
115
+ required_ruby_version: !ruby/object:Gem::Requirement
116
+ requirements:
117
+ - - ">="
118
+ - !ruby/object:Gem::Version
119
+ version: 2.2.2
120
+ required_rubygems_version: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: 1.8.11
125
+ requirements: []
126
+ rubyforge_project:
127
+ rubygems_version: 2.6.10
128
+ signing_key:
129
+ specification_version: 4
130
+ summary: A Ruby API client for Freshdesk API v2
131
+ test_files: []