galetahub-freshdesk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b91409f49e46b6886404f3f9023abc3a15bc8aca4c3547927a2d80f87ad586c1
+  data.tar.gz: fbfe786611d71c76d9354b74dbe9afb72116678b510d0d844c7c5f70e3789eb0
+SHA512:
+  metadata.gz: 1c1844206ee60aa47693e84cc411929e0a070509b56aede73e8878a8135ea54994b38692e4180c53453a72647ff2f2384965e3d94600d68d5807fb09e7235b86
+  data.tar.gz: c732c700d846b32db893a9edb49da5b75dc9c5d80249482e1df04c9f064f1f69fa00f754ad65debadf88f06f4287154235f2dd05b7e40da3c26f1fc3f8356759

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - 'app/views/**/*.slim'
+    - 'app/views/**/**/*.slim'
+
+Style/Documentation:
+  Enabled: false
+
+##################### Metrics ##################################
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/ModuleLength:
+  Max: 200
+
+##################### Rails ##################################
+
+Rails:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 2.0.1

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 galeta.igor@gmail.com. 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) 2019 Galeta Igor
+
+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,68 @@
+# Freshdesk
+
+API client for https://developers.freshdesk.com/api/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'galetahub-freshdesk', require: 'freshdesk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install galetahub-freshdesk
+
+## Usage
+
+### Setup
+
+```
+# config/initializers/freshdesk.rb
+
+require 'freshdesk'
+
+Freshdesk.configure do |config|
+  config.api_key = ENV['FRESHDESK_KEY']
+  config.domain = ENV['FRESHDESK_DOMAIN']
+end
+```
+
+### Company API
+
+```
+client = Freshdesk::Resources::Company.new
+client.all
+
+company = client.create(name: 'Test', description: 'Test')
+```
+
+### Contact API
+
+```
+client = Freshdesk::Resources::Contact.new
+client.create(name: '...', email: '...',  mobile: '...', company_id: company['id'])
+```
+
+## 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/galetahub/freshdesk. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Freshdesk project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/freshdesk/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+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 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshdesk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'galetahub-freshdesk'
+  spec.version       = Freshdesk::VERSION
+  spec.authors       = ['Galeta Igor']
+  spec.email         = ['galeta.igor@gmail.com']
+
+  spec.summary       = %q(Freshdesk client for API v2)
+  spec.description   = %q(Simple Freshdesk client for API v2 based on httparty gem)
+  spec.homepage      = 'https://github.com/galetahub/freshdesk'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.17.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/freshdesk.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'freshdesk/version'
+require 'freshdesk/configuration'
+
+require 'freshdesk/resources/attachment'
+require 'freshdesk/resources/company'
+require 'freshdesk/resources/contact'
+require 'freshdesk/resources/ticket'
+
+module Freshdesk
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/freshdesk/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Freshdesk
+  class Configuration
+    attr_accessor :api_key, :domain
+  end
+end

data/lib/freshdesk/resources/attachment.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'freshdesk/resources/base'
+
+module Freshdesk
+  module Resources
+    class Attachment < Base
+      self.collection_path = '/attachments'
+    end
+  end
+end

data/lib/freshdesk/resources/base.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Freshdesk
+  module Resources
+    class Base
+      include HTTParty
+
+      format :json
+      headers 'Content-Type' => 'application/json'
+
+      class << self
+        attr_accessor :collection_path
+      end
+
+      def initialize
+        self.class.base_uri "https://#{Freshdesk.configuration.domain}.freshdesk.com/api/v2"
+        @basic_auth = { username: Freshdesk.configuration.api_key }
+      end
+
+      def create(params)
+        post(self.class.collection_path, body: params)
+      end
+
+      def find(id, params = nil)
+        get(File.join(self.class.collection_path, id.to_s), query: params)
+      end
+
+      def all(params = nil)
+        get(self.class.collection_path, query: params)
+      end
+
+      def update(id, params)
+        put(File.join(self.class.collection_path, id.to_s), body: params)
+      end
+
+      def destroy(id)
+        delete(File.join(self.class.collection_path, id.to_s))
+      end
+
+      private
+
+      def get(*args)
+        request(:get, *args)
+      end
+
+      def post(*args)
+        request(:post, *args)
+      end
+
+      def put(*args)
+        request(:post, *args)
+      end
+
+      def delete(*args)
+        request(:delete, *args)
+      end
+
+      def request(method_type, path, options = {})
+        options[:basic_auth] ||= @basic_auth
+
+        response = self.class.send(method_type, path, options)
+        return unless response
+
+        response.parsed_response
+      end
+    end
+  end
+end

data/lib/freshdesk/resources/company.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'freshdesk/resources/base'
+
+module Freshdesk
+  module Resources
+    class Company < Base
+      self.collection_path = '/companies'
+    end
+  end
+end

data/lib/freshdesk/resources/contact.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'freshdesk/resources/base'
+
+module Freshdesk
+  module Resources
+    class Contact < Base
+      self.collection_path = '/contacts'
+
+      def hard_delete(id)
+        delete(File.join(self.class.collection_path, id.to_s, 'hard_delete'))
+      end
+
+      def restore(id)
+        put(File.join(self.class.collection_path, id.to_s, 'restore'))
+      end
+    end
+  end
+end

data/lib/freshdesk/resources/ticket.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'freshdesk/resources/base'
+
+module Freshdesk
+  module Resources
+    class Ticket < Base
+      self.collection_path = '/tickets'
+
+      def create_outbound_email(params)
+        post(File.join(self.class.collection_path, 'outbound_email'), body: params)
+      end
+
+      def restore(id)
+        put(File.join(self.class.collection_path, id.to_s, 'restore'))
+      end
+
+      def ticket_fields
+        get('/ticket_fields')
+      end
+
+      def conversations(id)
+        get(File.join(self.class.collection_path, id.to_s, 'conversations'))
+      end
+
+      def time_entries(id)
+        get(File.join(self.class.collection_path, id.to_s, 'time_entries'))
+      end
+    end
+  end
+end

data/lib/freshdesk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Freshdesk
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: galetahub-freshdesk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Galeta Igor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Simple Freshdesk client for API v2 based on httparty gem
+email:
+- galeta.igor@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freshdesk.gemspec
+- lib/freshdesk.rb
+- lib/freshdesk/configuration.rb
+- lib/freshdesk/resources/attachment.rb
+- lib/freshdesk/resources/base.rb
+- lib/freshdesk/resources/company.rb
+- lib/freshdesk/resources/contact.rb
+- lib/freshdesk/resources/ticket.rb
+- lib/freshdesk/version.rb
+homepage: https://github.com/galetahub/freshdesk
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Freshdesk client for API v2
+test_files: []