freshly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9ac1edd925e48223e6fcb1f12c05c3a8a51df3e
+  data.tar.gz: 63d832f0f9852207ea09d3973d5a6bdced198891
+SHA512:
+  metadata.gz: 8fed0a387c9c92c93a0faea0e094483fa9a1399f4226be797e8846711796d3e99e0b9b85d42088279776b515fba9d1c4dfe31bf907c4abd14f2aa90f530c5f76
+  data.tar.gz: d3372df6da4ad4db5795a860cbbeb4556f6d54532dc4781bba4b94571ac6a7e3cda218a204518240331eada3a8c6d0cd2db1faf94b773f5707fd15b3d12d5fe1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mail@samjohnduke.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sam John Duke
+
+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,55 @@
+# Freshly
+Freshly is a Ruby API wrapper for the Freshdesk API v2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freshly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install freshly
+
+## Usage
+
+Create a new API client using your Freshdesk API key
+
+```
+client = Freshly::Client.new api_key: {api_key}, api_endpoint: {api_endpoint}
+```
+
+or
+
+```
+client = Freshly::Client.new
+client.configure do |opts|
+  opts.api_key = {api_key}
+  opts.api_endpoint = {api_endpoint}
+end
+```
+
+
+Resources that are available are
+- Tickets
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/freshly. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freshly"
+
+# 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

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/freshly.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freshly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "freshly"
+  spec.version       = Freshly::VERSION
+  spec.authors       = ["Sam John Duke"]
+  spec.email         = ["mail@samjohnduke.com"]
+
+  spec.summary       = %q{Ruby api wrapper for the freshdesk api v2}
+  spec.description   = %q{Ruby api wrapper for the freshdesk api v2}
+  spec.homepage      = "https://github.com/samjohnduke/freshly"
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json"
+
+end

data/lib/freshly.rb

@@ -0,0 +1,15 @@
+require "freshly/version"
+require "freshly/default"
+require "freshly/client"
+
+##
+# Why is this empty
+#
+# Other api wrappers open include a way to query directly from the root
+# namespace. It might be useful for somethings however I don't think this is
+# a good practise. It encourages a user to just pickup and start using the
+# library without considering what they are doing. I am not forcing someone
+# to make an arduous amount of work, just making a simple thought about what
+# they are trying to achieve
+module Freshly
+end

data/lib/freshly/client.rb

@@ -0,0 +1,18 @@
+require "freshly/connection"
+require "freshly/configurable"
+require "freshly/client/tickets"
+
+module Freshly
+  class Client
+    include Freshly::Configurable
+    include Freshly::Connection
+    include Freshly::Client::Tickets
+
+    def initialize opts={}
+      Freshly::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", opts[key] || Freshly::Default.send(:"#{key}"))
+      end
+    end
+
+  end
+end

data/lib/freshly/client/tickets.rb

@@ -0,0 +1,49 @@
+module Freshly
+  class Client
+    module Tickets
+
+      def tickets options={}
+        paginate "tickets", options
+      end
+
+      def ticket options={}
+        get "ticket", options
+      end
+
+      def create_ticket options={}
+        post "tickets", options
+      end
+
+      def edit_ticket id, options={}
+        ticket = Ticket.new(id)
+        put ticket.path, options
+      end
+
+      def delete_ticket id, options={}
+        ticket = Ticket.new(id)
+        destroy ticket.path, options
+      end
+
+      def restore_ticket id, options={}
+        ticket = Ticket.new(id)
+        put "#{ticket.path}/restore", options
+      end
+
+      def reply_to_ticket id, options={}
+        ticket = Ticket.new(id)
+        post "#{ticket.path}/reply", options
+      end
+
+      def ticket_notes id, options={}
+        ticket = Ticket.new(id)
+        paginate "#{ticket.path}/notes", options
+      end
+
+      def ticket_time_entries id, options={}
+        ticket = Ticket.new(id)
+        paginate "#{ticket.path}/time_entries", options
+      end
+
+    end
+  end
+end

data/lib/freshly/configurable.rb

@@ -0,0 +1,30 @@
+module Freshly
+  module Configurable
+    attr_accessor :api_key, :api_endpoint, :media_type,
+                  :auto_paginate, :per_page, :user_agent,
+                  :connection_options, :middleware
+
+    class << self
+      def keys
+        @keys ||= [
+          :api_key,
+          :api_endpoint,
+          :auto_paginate,
+          :connection_options,
+          :media_type,
+          :per_page,
+          :user_agent,
+          :middleware
+        ]
+      end
+    end
+
+    def configure
+      yield self
+    end
+
+    def api_endpoint
+      File.join(@api_endpoint, "api/v2")
+    end
+  end
+end

data/lib/freshly/connection.rb

@@ -0,0 +1,45 @@
+module Freshly
+  module Connection
+    attr_reader :last_response
+
+    def get url, opts={}
+      request :get, url, opts
+    end
+
+    def post url, opts={}
+      request :post, url, opts
+    end
+
+    def put url, opts={}
+      request :put, url, opts
+    end
+
+    def destroy url, opts={}
+      request :delete, url, opts
+    end
+
+    def paginate url, opts={}
+      get url, opts
+    end
+
+  private
+
+    def conn
+      @conn ||=  Faraday.new(conn_opts)
+    end
+
+    def conn_opts
+      conn_opts = connection_options
+      conn_opts[:url] = api_endpoint
+      conn_opts[:builder] = middleware
+      conn_opts[:headers][:Authorization] = "Basic "+Base64.encode64("#{api_key}:X")
+      conn_opts
+    end
+
+    def request method, url, opts={}
+      @last_response = conn.send(method, url, opts)
+      @last_response.body
+    end
+
+  end
+end

data/lib/freshly/default.rb

@@ -0,0 +1,69 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'freshly/response/raise_error'
+
+module Freshly
+  module Default
+
+    # Default User Agent header string
+    USER_AGENT   = "Freshly #{Freshly::VERSION}".freeze
+
+    # Default media type
+    MEDIA_TYPE   = "application/json".freeze
+
+    # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
+    RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+
+    # Default Faraday middleware stack
+    MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use Freshly::Response::RaiseError
+      builder.response :json, :content_type => /\bjson$/
+      builder.adapter Faraday.default_adapter
+    end
+
+    PER_PAGE = 100
+
+    AUTO_PAGINATE = false
+
+    class << self
+
+      def api_key
+        ENV["FRESHLY_API_KEY"]
+      end
+
+      def api_endpoint
+        ENV["FRESHLY_API_ENDPOINT"]
+      end
+
+      def auto_paginate
+        AUTO_PAGINATE
+      end
+
+      def connection_options
+        {
+          :headers => {
+            :accept => media_type,
+            :user_agent => user_agent
+          }
+        }
+      end
+
+      def media_type
+        MEDIA_TYPE
+      end
+
+      def user_agent
+        ENV["FRESHLY_USER_AGENT"] || USER_AGENT
+      end
+
+      def middleware
+        MIDDLEWARE
+      end
+
+      def per_page
+        ENV["PER_PAGE"] || PER_PAGE
+      end
+
+    end
+  end
+end

data/lib/freshly/error.rb

@@ -0,0 +1,72 @@
+module Freshly
+  class Error < StandardError
+    attr_reader :response
+
+    def self.from_response response
+      status  = response[:status].to_i
+      body    = response[:body].to_s
+      headers = response[:response_headers]
+
+      if klass =  case status
+                  when 400      then Freshly::BadRequest
+                  when 401      then Freshly::AuthenticationFailed
+                  when 403      then Freshly::AccessDenied
+                  when 404      then Freshly::NotFound
+                  when 405      then Freshly::MethodNotAllowed
+                  when 406      then Freshly::NotAcceptable
+                  when 409      then Freshly::Conflict
+                  when 415      then Freshly::UnsupportedMediaType
+                  when 429      then Freshly::RateLimitExceeded
+                  when 400..499 then Freshly::ClientError
+                  when 500      then Freshly::InternalServerError
+                  when 501      then Freshly::NotImplemented
+                  when 502      then Freshly::BadGateway
+                  when 503      then Freshly::ServiceUnavailable
+                  when 500..599 then Freshly::ServerError
+                  end
+
+        klass.new(response)
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    def build_error_message
+      "something went wrong"
+    end
+  end
+
+  class BadRequest < Error; end
+
+  class AuthenticationFailed < Error; end
+
+  class AccessDenied < Error; end
+
+  class NotFound < Error; end
+
+  class MethodNotAllowed < Error; end
+
+  class NotAcceptable < Error; end
+
+  class Conflict < Error; end
+
+  class UnsupportedMediaType < Error; end
+
+  class RateLimitExceeded < Error; end
+
+  class ClientError < Error; end
+
+  class InternalServerError < Error; end
+
+  class NotImplemented < Error; end
+
+  class BadGateway < Error; end
+
+  class ServiceUnavailable < Error; end
+
+  class ServerError < Error; end
+
+end

data/lib/freshly/response/raise_error.rb

@@ -0,0 +1,22 @@
+require 'faraday'
+require 'freshly/error'
+
+module Freshly
+  # Faraday response middleware
+  module Response
+
+    # This class raises an exception based
+    # HTTP status codes returned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(response)
+        if error = Freshly::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+
+  end
+end

data/lib/freshly/version.rb

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: freshly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam John Duke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby api wrapper for the freshdesk api v2
+email:
+- mail@samjohnduke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- freshly.gemspec
+- lib/freshly.rb
+- lib/freshly/client.rb
+- lib/freshly/client/tickets.rb
+- lib/freshly/configurable.rb
+- lib/freshly/connection.rb
+- lib/freshly/default.rb
+- lib/freshly/error.rb
+- lib/freshly/response/raise_error.rb
+- lib/freshly/version.rb
+homepage: https://github.com/samjohnduke/freshly
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ruby api wrapper for the freshdesk api v2
+test_files: []