freshdesk_apiclient 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c1325f27dbe6b78e075ca30e6bd13eac3ce703c
+  data.tar.gz: 5083628601c39740f5541df1cb37bf63fba26ddc
+SHA512:
+  metadata.gz: 3ef19caa813097a04bc01c2615e9dc1cc21d7810772a1184faee30ea3c2af5dcbe20c0e7458d9266e3c4df3a9bbe31b8e61e6ca52242869ecb0ae635b27f24fc
+  data.tar.gz: d11d2ca82bd1e7d2a856b0f3cca693b80429eda9bd8ff0ce285d2ab08c52ded326ef417555af03d703b1eb20079ad0309a416867cb0dbc9383225707c15450af

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+engines:
+  rubocop:
+    enabled: true
+  brakeman:
+    enabled: false
+  eslint:
+    enabled: false
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+ratings:
+  paths:
+  - lib/**
+  - "**.rb"
+exclude_paths:
+- spec/**/*
+- "**/vendor/**/*"

data/.gitignore

@@ -0,0 +1,39 @@
+/spec/examples.txt
+coverage/
+*.gem
+.config
+lib/bundler/man
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore bundler config.
+/.bundle
+/vendor/bundle/
+/vendor/ruby/
+
+# Ignore all log files and tempfiles.
+/log/*
+!/log/.keep
+/tmp
+
+# various artifacts
+.project
+.secret
+.idea/
+/spec/tmp/*

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,253 @@
+Rails:
+  Enabled: true
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - "vendor/**/*"
+    - "bin/**/*"
+  UseCache: false
+
+# Commonly used screens these days easily fit more than 80 characters.
+Metrics/LineLength:
+  Max: 120
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+Style/SpaceInsideBlockBraces:
+  # The space here provides no real gain in readability while consuming
+  # horizontal space that could be used for a better parameter name.
+  # Also {| differentiates better from a hash than { | does.
+  SpaceBeforeBlockParameters: false
+
+# No trailing space differentiates better from the block:
+# foo} means hash, foo } means block.
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: leading
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context', 'shared_examples']
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1,2 @@
+freshdesk_apiclient
+

data/.ruby-version

@@ -0,0 +1,2 @@
+ruby-2.3.1
+

data/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
+  - gem update --system
+  - gem install bundler
+script:
+  - bundle exec rspec
+notifications:
+  email: false

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 erich@financialapps.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,5 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in freshdesk_apiclient.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Erich Quintero
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Erich Quintero
+
+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,39 @@
+# FreshdeskApiclient
+
+A ruby API client for freshdesk.com.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freshdesk_apiclient'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freshdesk_apiclient
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/qbantek/freshdesk_apiclient. 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,7 @@
+# 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_apiclient"
+
+# 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_apiclient.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshdesk_apiclient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'freshdesk_apiclient'
+  spec.version       = FreshdeskApiclient::VERSION
+  spec.authors       = ['Erich Quintero']
+  spec.email         = ['qbantek@gmail.com']
+
+  spec.summary       = 'A ruby API client for freshdesk.com.'
+  spec.homepage      = 'https://github.com/qbantek/freshdesk_apiclient'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.test_files = Dir['spec/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency     'rest-client',  '~> 2.0',   '>= 2.0.1'
+
+  spec.add_development_dependency 'bundler',      '~> 1.14',  '>= 1.14.3'
+  spec.add_development_dependency 'gem-release',  '~> 0.7',   '>= 0.7.4'
+  spec.add_development_dependency 'rake',         '~> 12.0',  '>= 12.0.0'
+  spec.add_development_dependency 'rspec',        '~> 3.5',   '>= 3.5.0'
+  spec.add_development_dependency 'rubocop',      '~> 0.47',  '>= 0.47.1'
+end

data/lib/freshdesk_apiclient.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'freshdesk_apiclient/version'
+
+require 'freshdesk_apiclient/utils/loggeable'
+require 'freshdesk_apiclient/utils/camelizable'
+
+require 'freshdesk_apiclient/rest/resources'
+require 'freshdesk_apiclient/rest/tickets'
+require 'freshdesk_apiclient/rest/client'

data/lib/freshdesk_apiclient/rest/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module FreshdeskApiclient
+  module REST
+    class Client
+      include FreshdeskApiclient::Utils::Loggeable
+      include FreshdeskApiclient::Utils::Camelizable
+
+      RESOURCES = %i(tickets).freeze
+
+      # @param [String] domain
+      # @param [String] username_or_api_key
+      # @param [String] password
+      # @param [Hash] options
+      def initialize(domain, username_or_api_key, password='X', options={})
+        @base_url = "https://#{domain}.freshdesk.com/api/v2/"
+        @credentials = {username: username_or_api_key, password: password}
+        @logger = options[:logger] if options.key?(:logger) && options[:logger].respond_to?(:info)
+      end
+
+      # obj.method_missing(symbol [, *args] )   -> result
+      def method_missing(symbol, *arguments, &block)
+        if RESOURCES.include? symbol
+          class_name = camelize(symbol.to_s)
+          variable = "@#{class_name.downcase}"
+          unless instance_variable_defined? variable
+            klass = Object.const_get('FreshdeskApiclient').const_get('REST').const_get class_name
+            instance_variable_set(variable, klass.new(@base_url, credentials: @credentials, logger: logger))
+          end
+          instance_variable_get(variable)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_sym, include_private=false)
+        RESOURCES.include?(method_sym) ? true : super
+      end
+    end
+  end
+end

data/lib/freshdesk_apiclient/rest/resources.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'rest-client'
+require 'forwardable'
+require 'base64'
+
+module FreshdeskApiclient
+  module REST
+    class Resources
+      def initialize(base_url, options={})
+        @url = "#{base_url}/#{options[:path] || end_point}"
+        @headers = headers options[:credentials]
+        RestClient.log = options[:logger]
+      end
+
+      def list
+        RestClient::Request.execute(method: :get,
+                                    url: @url,
+                                    headers: @headers.dup.reject! {|key| [:'Content-Type'].include?(key) })
+      end
+
+      def create(json_payload)
+        RestClient::Request.execute(method: :post,
+                                    url: @url,
+                                    headers: @headers,
+                                    payload: json_payload)
+      end
+
+      protected
+
+      def end_point
+        self.class.name.split('::').last.downcase
+      end
+
+      private
+
+      def headers(credentials)
+        {
+          Authorization: "Basic #{Base64.encode64("#{credentials[:username]}:#{credentials[:password]}")}",
+          'Content-Type': 'application/json',
+          Accept: 'application/json'
+        }
+      end
+    end
+  end
+end

data/lib/freshdesk_apiclient/rest/tickets.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require_relative '../../../lib/freshdesk_apiclient/rest/resources' unless defined?(FreshdeskApiclient::REST::Resources)
+
+module FreshdeskApiclient
+  module REST
+    class Tickets < FreshdeskApiclient::REST::Resources; end
+  end
+end

data/lib/freshdesk_apiclient/utils/camelizable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module FreshdeskApiclient
+  module Utils
+    module Camelizable
+      def camelize(term)
+        string = term.to_s
+        string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+        string.gsub!(%r{(?:_|(/))([a-z\d]*)}) { $2.capitalize.to_s }
+        string
+      end
+    end
+  end
+end

data/lib/freshdesk_apiclient/utils/loggeable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module FreshdeskApiclient
+  module Utils
+    module Loggeable
+      def logger
+        @logger ||= standard_out_logger
+      end
+
+      def standard_out_logger
+        require 'logger'
+        Logger.new(STDOUT).tap {|log| log.level = Logger::INFO }
+      end
+    end
+  end
+end

data/lib/freshdesk_apiclient/version.rb

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

data/lib/tasks/releaser.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+desc 'Bumps the version to the next patch level, tags and pushes the code to
+origin repository and releases the gem. BOOM!'
+task :release do
+  system 'gem bump --tag --release'
+end

data/spec/freshdesk_apiclient_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+RSpec.describe FreshdeskApiclient do
+  it 'has a version number' do
+    expect(FreshdeskApiclient::VERSION).not_to be nil
+  end
+end

data/spec/rest/client_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require 'logger' unless defined?(Logger)
+unless defined?(FreshdeskApiclient::Utils::Camelizable)
+  require_relative '../../lib/freshdesk_apiclient/utils/camelizable'
+end
+require_relative '../../lib/freshdesk_apiclient/utils/loggeable' unless defined?(FreshdeskApiclient::Utils::Loggeable)
+require_relative '../../lib/freshdesk_apiclient/rest/client' unless defined?(FreshdeskApiclient::REST::Client)
+require_relative '../../lib/freshdesk_apiclient/rest/tickets' unless defined?(FreshdeskApiclient::REST::Tickets)
+require_relative '../../lib/freshdesk_apiclient/rest/resources' unless defined?(FreshdeskApiclient::REST::Resources)
+
+describe FreshdeskApiclient::REST::Client do
+  subject { FreshdeskApiclient::REST::Client.new(:domain, :api_key) }
+  describe '#new' do
+    it 'sets the base_url for the given domain' do
+      expect(subject.instance_variable_get(:@base_url)).to eql("https://#{:domain}.freshdesk.com/api/v2/")
+    end
+
+    context 'when password is provided' do
+      subject { FreshdeskApiclient::REST::Client.new(:domain, :api_key, :password) }
+      it 'sets the credentials for the given parameters' do
+        expect(subject.instance_variable_get(:@credentials)[:username]).to eq(:api_key)
+        expect(subject.instance_variable_get(:@credentials)[:password]).to eq(:password)
+      end
+    end
+
+    context 'when password is not provided' do
+      it 'sets the credentials for the given api_key and default password' do
+        expect(subject.instance_variable_get(:@credentials)[:username]).to eq(:api_key)
+        expect(subject.instance_variable_get(:@credentials)[:password]).to eq('X')
+      end
+    end
+
+    it 'sets the credentials for the given parameters' do
+      expect(subject.instance_variable_get(:@credentials)[:username]).to eq(:api_key)
+      expect(subject.instance_variable_get(:@credentials)[:password]).to eq('X')
+    end
+
+    context 'when a logger option is not provided' do
+      it('does not sets the logger') { expect(subject.instance_variable_get(:@logger)).to be_nil }
+    end
+
+    context 'when a logger option is provided' do
+      subject { FreshdeskApiclient::REST::Client.new(:domain, :api_key, nil, logger: Logger.new(STDOUT)) }
+      it('sets the logger') { expect(subject.instance_variable_get(:@logger)).to be_a(Logger) }
+    end
+  end
+
+  FreshdeskApiclient::REST::Client::RESOURCES.each do |method|
+    it("responds to ##{method}") { expect(subject).to respond_to(method) }
+
+    describe "##{method}" do
+      it do
+        klass = Object.const_get('FreshdeskApiclient').const_get('REST').const_get subject.camelize(method.to_s)
+        expect(subject.send(method)).to be_an_instance_of(klass)
+      end
+    end
+
+    it "memoizes the result of ##{method}" do
+      first = subject.send(method)
+      second = subject.send(method)
+      expect(first.object_id).to eq(second.object_id)
+    end
+  end
+end

data/spec/rest/resources_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+require_relative '../../lib/freshdesk_apiclient/rest/resources' unless defined?(FreshdeskApiclient::REST::Resources)
+
+RSpec.describe FreshdeskApiclient::REST::Resources do
+  subject { FreshdeskApiclient::REST::Resources.new(:url, credentials: {username: :u, password: :p}) }
+
+  RSpec.shared_examples 'a resource' do
+    let(:get_headers) { {Authorization: "Basic dTpw\n", Accept: 'application/json'} }
+    let(:post_headers) { get_headers.merge('Content-Type': 'application/json') }
+    let(:path) { subject.class.name.split('::').last.downcase }
+
+    describe '#new' do
+      context 'when path option is provided' do
+        subject { FreshdeskApiclient::REST::Resources.new(:url, credentials: {username: :u, password: :p}, path: :foo) }
+        it 'sets the url using given path' do
+          expect(subject.instance_variable_get(:@url)).to eql("#{:url}/#{:foo}")
+        end
+      end
+
+      context 'when path option is not provided' do
+        it 'sets the url for the given resource' do
+          expect(subject.instance_variable_get(:@url)).to eql("#{:url}/#{path}")
+        end
+      end
+
+      it 'sets the Authorization header for the given credentials' do
+        expect(subject.instance_variable_get(:@headers)[:Authorization]).to eql(get_headers[:Authorization])
+      end
+
+      it 'sets the Accept header to accept JSON' do
+        expect(subject.instance_variable_get(:@headers)[:Accept]).to eql(get_headers[:Accept])
+      end
+
+      it 'sets the Content-Type header to indicate JSON content' do
+        expect(subject.instance_variable_get(:@headers)[:'Content-Type']).to eql(post_headers[:'Content-Type'])
+      end
+
+      it('sets the logger on RestClient') do
+        rest_client = object_double('RestClient', :log= => nil).as_stubbed_const
+        logger = Logger.new(STDOUT)
+        FreshdeskApiclient::REST::Resources.new(:url,
+                                                credentials: {
+                                                  username: :u,
+                                                  password: :p
+                                                },
+                                                logger: logger)
+        expect(rest_client).to have_received(:log=).with(logger)
+      end
+    end
+
+    describe '#list' do
+      it('executes the request as a GET') do
+        request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+        subject.list
+        expect(request).to have_received(:execute).with(method: :get, url: "#{:url}/#{path}", headers: get_headers)
+      end
+    end
+
+    describe '#create' do
+      it('executes the request as a POST') do
+        request = object_double('RestClient::Request', execute: nil).as_stubbed_const
+        subject.create :payload
+        expect(request).to have_received(:execute).with(method: :post,
+                                                        url: "#{:url}/#{path}",
+                                                        headers: post_headers,
+                                                        payload: :payload)
+      end
+    end
+  end
+
+  it_behaves_like 'a resource'
+end

data/spec/rest/tickets_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require_relative 'resources_spec' unless defined?(FreshdeskApiclient::REST::Resources)
+require_relative '../../lib/freshdesk_apiclient/rest/resources' unless defined?(FreshdeskApiclient::REST::Resources)
+require_relative '../../lib/freshdesk_apiclient/rest/tickets' unless defined?(FreshdeskApiclient::REST::Tickets)
+
+describe FreshdeskApiclient::REST::Tickets do
+  subject { FreshdeskApiclient::REST::Tickets.new(:url, credentials: {username: :u, password: :p}) }
+
+  it_behaves_like 'a resource'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'bundler/setup'
+Bundler.setup
+
+require 'freshdesk_apiclient'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: freshdesk_apiclient
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Erich Quintero
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+description: 
+email:
+- qbantek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freshdesk_apiclient.gemspec
+- lib/freshdesk_apiclient.rb
+- lib/freshdesk_apiclient/rest/client.rb
+- lib/freshdesk_apiclient/rest/resources.rb
+- lib/freshdesk_apiclient/rest/tickets.rb
+- lib/freshdesk_apiclient/utils/camelizable.rb
+- lib/freshdesk_apiclient/utils/loggeable.rb
+- lib/freshdesk_apiclient/version.rb
+- lib/tasks/releaser.rake
+- spec/freshdesk_apiclient_spec.rb
+- spec/rest/client_spec.rb
+- spec/rest/resources_spec.rb
+- spec/rest/tickets_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/qbantek/freshdesk_apiclient
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A ruby API client for freshdesk.com.
+test_files:
+- spec/rest/client_spec.rb
+- spec/rest/tickets_spec.rb
+- spec/rest/resources_spec.rb
+- spec/freshdesk_apiclient_spec.rb
+- spec/spec_helper.rb