backlog_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f52f835e713640f057e50476ea96d308ab359684
+  data.tar.gz: 4d97ec001c423469eaaab2a8dea4426ed5e8ab32
+SHA512:
+  metadata.gz: 53ca34f6d01240844780a3dba2630d57113243cf8db6c6d56b50abed53ec93f749ce4097eb97e2395050ef5035e9f0ad1b9421db94858df112e83e77ac778881
+  data.tar.gz: f1e837cbf1670e928abca9d4f2f8537fe3e061005a3ce61fe549957678172b45e886210bb4e8da98ac6e64624b0fafa9e621a6e78eb4b65c218ecce112d67791

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 emsk
+
+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,69 @@
+# BacklogKit
+
+Ruby wrapper for the Nulab's Backlog API.
+
+http://developer.nulab-inc.com/docs/backlog
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backlog_kit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backlog_kit
+
+## Usage
+
+```ruby
+require 'backlog_kit'
+
+client = BacklogKit::Client.new(space_id: 'emsk', api_key: '1234567890abcdefghij1234567890abcdefghij1234567890abcdefghij1234')
+
+client.get('space').body # get body
+client.get('space').headers # get headers
+client.get('space').status # get status
+
+client.get('space/activities') # no params
+client.get('space/activities', activity_type_id: [1, 4], min_id: 100) # underscored key
+client.get('space/activities', activityTypeId: [1, 4], minId: 100) # camelized key
+
+client.post('groups', name: 'beer') # POST method
+client.put('space/notification', content: 'Cheers!') # PUT method
+client.patch('groups/3712', name: 'whiskey') # PATCH method
+client.delete('groups/3712') # DELETE method
+```
+
+## ENV
+
+| ENV Variable | Description |
+| :----------- | :---------- |
+| `BACKLOG_SPACE_ID` | Your Backlog SPACE ID. |
+| `BACKLOG_API_KEY` | Your Backlog API KEY. |
+
+You can create instance more easily.
+
+```ruby
+client = BacklogKit::Client.new
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/emsk/backlog_kit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+task default: :spec

data/backlog_kit.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backlog_kit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'backlog_kit'
+  spec.version       = BacklogKit::VERSION
+  spec.authors       = ['emsk']
+  spec.email         = ['emsk1987@gmail.com']
+
+  spec.summary       = %q{Wrapper for the Backlog API v2.}
+  spec.description   = %q{Client library for the Nulab's Backlog API version 2 written in Ruby.}
+  spec.homepage      = 'https://github.com/emsk/backlog_kit'
+  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_runtime_dependency 'activesupport', '~> 4.2.1'
+  spec.add_runtime_dependency 'faraday', '~> 0.9.1'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.9.1'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_development_dependency 'multi_json', '~> 1.11.0'
+  spec.add_development_dependency 'vcr', '~> 2.9.3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'backlog_kit'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/backlog_kit.rb

@@ -0,0 +1,5 @@
+require 'active_support/core_ext/string/inflections'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'backlog_kit/client'

data/lib/backlog_kit/client.rb

@@ -0,0 +1,76 @@
+require 'backlog_kit/error'
+require 'backlog_kit/response'
+require 'backlog_kit/version'
+require 'backlog_kit/response/file_parser'
+require 'backlog_kit/response/raise_error'
+require 'backlog_kit/hash_extensions'
+
+module BacklogKit
+  class Client
+    USER_AGENT = "BacklogKit Ruby Gem #{BacklogKit::VERSION}".freeze
+
+    attr_accessor(:space_id, :api_key)
+
+    def initialize(options = {})
+      @space_id = ENV['BACKLOG_SPACE_ID']
+      @api_key  = ENV['BACKLOG_API_KEY']
+
+      options.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+
+    def patch(path, params = {})
+      request(:patch, path, params)
+    end
+
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    private
+
+    def request(method, path, params = {})
+      params.camelize_keys!
+      faraday_response = connection.send(method, request_path(path), params)
+      BacklogKit::Response.new(faraday_response)
+    rescue Faraday::ConnectionFailed => e
+      raise BacklogKit::Error, "#{BacklogKit::ConnectionError.name.demodulize} - #{e.message}"
+    end
+
+    def connection
+      Faraday.new(url: host, headers: request_headers) do |faraday|
+        faraday.request(:multipart)
+        faraday.request(:url_encoded)
+        faraday.response(:json, content_type: /application\/json/)
+        faraday.response(:file_parser)
+        faraday.response(:error)
+        faraday.adapter(Faraday.default_adapter)
+      end
+    end
+
+    def host
+      "https://#{space_id}.backlog.jp"
+    end
+
+    def request_headers
+      { 'User-Agent' => USER_AGENT }
+    end
+
+    def request_path(path)
+      "/api/v2/#{URI.escape(path)}?apiKey=#{URI.escape(@api_key.to_s)}"
+    end
+  end
+end

data/lib/backlog_kit/error.rb

@@ -0,0 +1,25 @@
+module BacklogKit
+  class Error < StandardError
+    def self.build_error_message(response, index)
+      message = "[ERROR #{index}] "
+      message += "#{self.name.demodulize} - #{response['message']} (CODE: #{response['code']})"
+      more_info = response['moreInfo'].to_s
+      message += " (MORE INFO: #{more_info})" unless more_info.empty?
+      message
+    end
+  end
+
+  class ConnectionError < Error; end
+  class UnexpectedError < Error; end
+  class InternalError < Error; end
+  class LicenceError < Error; end
+  class LicenceExpiredError < Error; end
+  class AccessDeniedError < Error; end
+  class UnauthorizedOperationError < Error; end
+  class NoResourceError < Error; end
+  class InvalidRequestError < Error; end
+  class SpaceOverCapacityError < Error; end
+  class ResourceOverflowError < Error; end
+  class TooLargeFileError < Error; end
+  class AuthenticationError < Error; end
+end

data/lib/backlog_kit/hash_extensions.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/hash/keys'
+
+class Hash
+  def camelize_keys!
+    deep_transform_keys! do |key|
+      key.to_s
+        .split(/(_*\d+_*)/)
+        .reject(&:empty?)
+        .map { |key| key.camelize(:lower) }
+        .join('_')
+        .to_sym
+    end
+
+    self
+  end
+end

data/lib/backlog_kit/resource.rb

@@ -0,0 +1,77 @@
+module BacklogKit
+  class Resource
+    def initialize(raw_data = {})
+      @attributes = {}
+
+      raw_data.each do |key, value|
+        @attributes[key.to_sym] = process_value(value)
+      end
+
+      eigenclass = class << self; self; end
+      eigenclass.send(:define_accessors, raw_data.keys)
+    end
+
+    class << self
+      def define_accessors(attributes)
+        attributes.each do |attribute|
+          define_reader(attribute)
+          define_writer(attribute)
+          define_boolean_method(attribute)
+        end
+      end
+
+      def define_reader(attribute)
+        class_eval do
+          define_method(attribute) do
+            @attributes[attribute.to_sym]
+          end
+
+          alias_method(attribute.underscore, attribute)
+        end
+      end
+
+      def define_writer(attribute)
+        method_name = "#{attribute}="
+        alias_method_name = "#{attribute.underscore}="
+
+        class_eval do
+          define_method(method_name) do |value|
+            @attributes[attribute.to_sym] = value
+          end
+
+          alias_method(alias_method_name, method_name)
+        end
+      end
+
+      def define_boolean_method(attribute)
+        method_name = "#{attribute}?"
+        alias_method_name = "#{attribute.underscore}?"
+
+        class_eval do
+          define_method(method_name) do
+            !!@attributes[attribute.to_sym]
+          end
+
+          alias_method(alias_method_name, method_name)
+        end
+      end
+    end
+
+    private_class_method(
+      :define_accessors,
+      :define_reader,
+      :define_writer,
+      :define_boolean_method
+    )
+
+    private
+
+    def process_value(value)
+      case value
+      when Hash  then self.class.new(value)
+      when Array then value.map { |v| process_value(v) }
+      else value
+      end
+    end
+  end
+end

data/lib/backlog_kit/resource_file.rb

@@ -0,0 +1,10 @@
+module BacklogKit
+  class ResourceFile
+    attr_accessor(:filename, :content)
+
+    def initialize(filename, content)
+      @filename = filename
+      @content  = content
+    end
+  end
+end

data/lib/backlog_kit/response.rb

@@ -0,0 +1,24 @@
+require 'backlog_kit/resource'
+
+module BacklogKit
+  class Response
+    attr_reader(:headers, :status, :body)
+
+    def initialize(response)
+      @headers = process(response.headers)
+      @status  = process(response.status)
+      @body    = process(response.body)
+    end
+
+    private
+
+    def process(raw)
+      case raw
+      when Hash   then Resource.new(raw)
+      when Array  then raw.map { |hash| process(hash) }
+      when String then Resource.new
+      else raw
+      end
+    end
+  end
+end

data/lib/backlog_kit/response/file_parser.rb

@@ -0,0 +1,33 @@
+require 'backlog_kit/response/middleware'
+require 'backlog_kit/resource_file'
+
+module BacklogKit
+  class Response
+    class FileParser < BacklogKit::Response::Middleware
+      def on_complete(env)
+        super
+        env.body = BacklogKit::ResourceFile.new(decoded_filename, body) if file?
+      end
+
+      private
+
+      def file?
+        !(no_content? || json?)
+      end
+
+      def decoded_filename
+        match_data = content_disposition.match(/=(.*)''(.+)\z/)
+        encode = match_data[1]
+        filename = match_data[2]
+        return filename if encode.empty?
+        URI.decode_www_form(filename, encode).flatten.first
+      end
+
+      def content_disposition
+        headers['content-disposition']
+      end
+    end
+
+    Faraday::Response.register_middleware(file_parser: FileParser)
+  end
+end

data/lib/backlog_kit/response/middleware.rb

@@ -0,0 +1,27 @@
+module BacklogKit
+  class Response
+    class Middleware < Faraday::Response::Middleware
+      attr_reader(:headers, :status, :body)
+
+      def on_complete(env)
+        @headers = env.response_headers
+        @status  = env.status
+        @body    = env.body
+      end
+
+      private
+
+      def no_content?
+        status == 204
+      end
+
+      def json?
+        !!content_type.match(/application\/json/)
+      end
+
+      def content_type
+        headers['content-type']
+      end
+    end
+  end
+end

data/lib/backlog_kit/response/raise_error.rb

@@ -0,0 +1,47 @@
+require 'backlog_kit/response/middleware'
+
+module BacklogKit
+  class Response
+    class RaiseError < BacklogKit::Response::Middleware
+      CODE_ERRORS = {
+        1  => BacklogKit::InternalError,
+        2  => BacklogKit::LicenceError,
+        3  => BacklogKit::LicenceExpiredError,
+        4  => BacklogKit::AccessDeniedError,
+        5  => BacklogKit::UnauthorizedOperationError,
+        6  => BacklogKit::NoResourceError,
+        7  => BacklogKit::InvalidRequestError,
+        8  => BacklogKit::SpaceOverCapacityError,
+        9  => BacklogKit::ResourceOverflowError,
+        10 => BacklogKit::TooLargeFileError,
+        11 => BacklogKit::AuthenticationError
+      }.freeze
+
+      def on_complete(env)
+        super
+        raise BacklogKit::Error, error_message unless success?
+      end
+
+      private
+
+      def success?
+        no_content? || !json? || json_body.is_a?(Array) || json_body['errors'].nil?
+      end
+
+      def error_message
+        messages = []
+        json_body['errors'].each.with_index(1) do |error, index|
+          klass = CODE_ERRORS[error['code']] || BacklogKit::UnexpectedError
+          messages.push(klass.build_error_message(error, index))
+        end
+        messages.join(', ')
+      end
+
+      def json_body
+        @json_body ||= JSON.parse(body)
+      end
+    end
+
+    Faraday::Response.register_middleware(error: RaiseError)
+  end
+end

data/lib/backlog_kit/version.rb

@@ -0,0 +1,3 @@
+module BacklogKit
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: backlog_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- emsk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+description: Client library for the Nulab's Backlog API version 2 written in Ruby.
+email:
+- emsk1987@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backlog_kit.gemspec
+- bin/console
+- bin/setup
+- lib/backlog_kit.rb
+- lib/backlog_kit/client.rb
+- lib/backlog_kit/error.rb
+- lib/backlog_kit/hash_extensions.rb
+- lib/backlog_kit/resource.rb
+- lib/backlog_kit/resource_file.rb
+- lib/backlog_kit/response.rb
+- lib/backlog_kit/response/file_parser.rb
+- lib/backlog_kit/response/middleware.rb
+- lib/backlog_kit/response/raise_error.rb
+- lib/backlog_kit/version.rb
+homepage: https://github.com/emsk/backlog_kit
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Wrapper for the Backlog API v2.
+test_files: []