nine-redmine-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fba5a853caa230da439567826e09696d878f377a
+  data.tar.gz: 8e48a5be8c0ecf6d5f13964be9f8530658f5fe9c
+SHA512:
+  metadata.gz: 0d528a0952735dac141625005248b6ac9253b5e449080fdeb95fa74dafff62a79d7b90af6a94ad0d1996e1d9c634e8860e9cb1ab22ae88abc27ebfb8a6f7f32d
+  data.tar.gz: 47f7b69ea73e8c4a3cc41dd157c5eb67ec65e4335c090c202dc8565852c89b413b872eb9e15c2fa0901c130af848632193caccfc3b3ed39bacbba869024e15c2

data/.gitignore

@@ -0,0 +1,3 @@
+
+Gemfile.lock
+/.bundle

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+redmine-client-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+
+gemfile:
+  - gemfiles/activesupport-4.0.gemfile
+  - gemfiles/activesupport-4.1.gemfile
+  - gemfiles/activesupport-4.2.gemfile

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+
+# 1.0.0
+
+
+
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+# Redmine Ruby Client
+
+[![Build Status](https://travis-ci.org/ninech/redmine-client.svg?branch=master)](https://travis-ci.org/ninech/redmine-client)
+
+Ruby client library for the Redmine API.
+
+## Configuration
+
+In your Rails app create a file `config/initializers/redmine.rb` with the following content:
+
+```ruby
+RedmineClient::API.configure do |config|
+  config.url = ENV['REDMINE_URL']
+  config.token = ENV['REDMINE_TOKEN']
+end
+```
+
+Here you have to set the config values via environment variables. But you're free to do it differently.
+
+## Usage
+
+The client is very limited. Actually it can only find, create and update issues. That's all for now. But
+great things start small.
+
+```ruby
+RedmineClient::Issue.create subject: 'Do this and that', project_id: 1
+
+issue = RedmineClient::Issue.find(1)
+issue.update subject: 'New Subject'
+```

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = '--format doc --profile'
+end
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/nine-redmine-client

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+require 'pry'
+
+APP_ROOT = File.join(File.dirname(Pathname.new(__FILE__).realpath),'..')
+
+$:.unshift File.join(APP_ROOT, 'lib')
+$:.unshift File.join(APP_ROOT, 'vendor/bundle')
+
+Dir.chdir(APP_ROOT)
+
+require 'bundler/setup'
+require 'nine-redmine-client'
+
+fail 'REDMINE_API_KEY environment variable not set!' unless ENV['REDMINE_API_KEY']
+
+RedmineClient::API.configure do |config|
+  config.url = 'http://redmine.dev/'
+  config.token = ENV['REDMINE_API_KEY']
+end
+
+binding.pry

data/gemfiles/activesupport-4.0.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.0.0'
+
+gemspec path: '../'

data/gemfiles/activesupport-4.1.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.1.0'
+
+gemspec path: '../'
+

data/gemfiles/activesupport-4.2.gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.2.0'
+
+gemspec path: '../'
+

data/lib/nine-redmine-client.rb

@@ -0,0 +1 @@
+require 'redmine_client'

data/lib/redmine_client.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+
+module RedmineClient
+end
+
+require 'redmine_client/errors'
+require 'redmine_client/api'
+require 'redmine_client/base'
+require 'redmine_client/issue'

data/lib/redmine_client/api.rb

@@ -0,0 +1,21 @@
+require 'active_support/configurable'
+
+module RedmineClient
+  class API
+    def self.config
+      @config ||= Configuration.new
+    end
+
+    def self.configure
+      yield config
+      Base.setup
+    end
+  end
+
+  class API::Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor(:url)
+    config_accessor(:token)
+  end
+end

data/lib/redmine_client/base.rb

@@ -0,0 +1,81 @@
+require 'ostruct'
+require 'forwardable'
+
+module RedmineClient
+  HEADERS = {
+    'User-Agent'    => 'Ruby.Redmine.Client',
+    'Accept'        => 'application/json',
+    'Content-Type'  => 'application/x-www-form-urlencoded',
+  }.freeze
+
+  class Base < OpenStruct
+    include HTTParty
+
+    format :json
+
+    extend Forwardable
+    def_delegators 'self.class', :delete, :get, :post, :put, :resource_path, :resource_name, :bad_response
+
+    def update(attrs = {})
+      resource = put "#{resource_path}/#{id}.json", body: { resource_name => attrs }
+      if resource.success?
+        data = Hash[attrs.map { |key, value| [key.to_sym, value] }]
+        @table.merge!(data)
+      else
+        false
+      end
+    end
+
+    class << self
+      def setup
+        base_uri RedmineClient::API.config.url
+        headers HEADERS.merge('X-Redmine-API-Key' => RedmineClient::API.config.token)
+      end
+
+      def resource_path
+        klass = name.split('::').last
+        klass[0] = klass[0].chr.downcase
+        klass.end_with?('y') ? "/#{klass.chop}ies" : "/#{klass}s"
+      end
+
+      def resource_name
+        klass = name.split('::').last
+        klass.downcase
+      end
+
+      def bad_response(response, _params = {})
+        if response.class == HTTParty::Response
+          case response.code
+          when 403
+            fail Errors::AccessDeniedException
+          when 404
+            fail Errors::ResourceNotFoundException
+          when 422
+            fail Errors::UnprocessableEntityException, response
+          when 500
+            fail Errors::InternalErrorException
+          else
+            fail HTTParty::ResponseError, response
+          end
+        end
+
+        fail StandardError, 'Unknown error'
+      end
+
+      def find(id)
+        resource = get "#{resource_path}/#{id}.json"
+        resource.ok? ? new(resource[resource_name]) : bad_response(resource, id)
+      end
+
+      def create(attrs = {})
+        resource = post "#{resource_path}.json", body: { resource_name => attrs }
+        if resource.success?
+          data = attrs.merge resource[resource_name]
+          new(data)
+        else
+          bad_response(resource, attrs)
+        end
+      end
+    end
+  end
+end

data/lib/redmine_client/errors.rb

@@ -0,0 +1,31 @@
+module RedmineClient
+  module Errors
+    class AccessDeniedException < StandardError
+      def to_s
+        'Access denied.'
+      end
+    end
+
+    class ResourceNotFoundException < StandardError
+      def to_s
+        'Resource not found.'
+      end
+    end
+
+    class UnprocessableEntityException < StandardError
+      def initialize(response)
+        @errors = response.parsed_response['errors']
+      end
+
+      def to_s
+        @errors.join(', ')
+      end
+    end
+
+    class InternalErrorException < StandardError
+      def to_s
+        'Internal error'
+      end
+    end
+  end
+end

data/lib/redmine_client/issue.rb

@@ -0,0 +1,12 @@
+module RedmineClient
+  class Issue < Base
+    def self.search(arguments)
+      issues = get "#{resource_path}.json", query: arguments
+      if issues.ok?
+        issues['issues'].map { |issue| new(issue) }
+      else
+        bad_response(issues, arguments)
+      end
+    end
+  end
+end

data/nine-redmine-client.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+#
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'nine-redmine-client'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.authors     = ['nine.ch Development-Team']
+  s.email       = ['development@nine.ch']
+  s.homepage    = 'http://github.com/ninech/'
+  s.license     = 'MIT'
+  s.summary     = 'Redmine API ruby client library'
+  s.description = 'To access the Redmine API from ruby scripts.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'pry', '~> 0.10.0'
+
+  s.add_runtime_dependency 'httparty'
+  s.add_runtime_dependency 'activesupport', '>= 4.0.0'
+end

data/spec/redmine_client/base_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+RSpec.describe RedmineClient::Base do
+  describe '.resource_path' do
+    subject { RedmineClient::Base.resource_path }
+    it { should eq '/bases' }
+  end
+
+  describe '.resource_name' do
+    subject { RedmineClient::Base.resource_name }
+    it { should eq 'base' }
+  end
+
+  describe '.bad_response' do
+    subject { described_class.bad_response(response) }
+
+    context 'valid response object' do
+      let(:response) { instance_double('HTTParty::Response', class: HTTParty::Response, code: 500) }
+
+      it 'raises a response error' do
+        expect { subject }.to raise_error RedmineClient::Errors::InternalErrorException
+      end
+    end
+
+    context 'unknown error' do
+      let(:response) { double }
+
+      it 'raises a standard error' do
+        expect { subject }.to raise_error StandardError
+      end
+    end
+
+    context 'access denied' do
+      let(:response) { instance_double('HTTParty::Response', class: HTTParty::Response, code: 403) }
+
+      it 'raises the correct error' do
+        expect { subject }.to raise_error RedmineClient::Errors::AccessDeniedException
+      end
+    end
+
+    context 'resource not found' do
+      let(:response) { instance_double('HTTParty::Response', class: HTTParty::Response, code: 404) }
+
+      it 'raises the correct error' do
+        expect { subject }.to raise_error RedmineClient::Errors::ResourceNotFoundException
+      end
+    end
+
+    context 'Unprocessable entity error' do
+      let(:response) { instance_double('HTTParty::Response', class: HTTParty::Response, code: 422) }
+
+      before do
+        allow(response).to receive(:parsed_response).
+          and_return('errors' => ['a is bad', 'b is bad'])
+      end
+
+      it 'raises the correct error' do
+        expect { subject }.to raise_error RedmineClient::Errors::UnprocessableEntityException
+      end
+
+      it 'displays a human-readable error message' do
+        expect { subject }.to raise_error(
+          RedmineClient::Errors::UnprocessableEntityException,
+          'a is bad, b is bad'
+        )
+      end
+    end
+  end
+
+  describe '.find' do
+    subject { RedmineClient::Base.find(1) }
+
+    it 'starts a get request with the correct path' do
+      allow(RedmineClient::Base).to receive(:new)
+
+      expect(RedmineClient::Base).to receive(:get).with('/bases/1.json').and_return double(ok?: true, :[] => '')
+
+      RedmineClient::Base.find(1)
+    end
+
+    it 'creates a new instance when the response is ok' do
+      response = double(ok?: true, :[] => {})
+      allow(RedmineClient::Base).to receive(:get).and_return(response)
+
+      expect(RedmineClient::Base).to receive(:new).with({})
+      RedmineClient::Base.find(1)
+    end
+
+    it 'fails when the response smells' do
+      response = double(ok?: false)
+      allow(RedmineClient::Base).to receive(:get).and_return(response)
+      expect(RedmineClient::Base).to receive(:bad_response).with(response, 1)
+      RedmineClient::Base.find(1)
+    end
+  end
+end

data/spec/redmine_client/issue_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe RedmineClient::Issue do
+  describe '.search' do
+    subject { RedmineClient::Issue.search(subject: 'nice subject', status_id: '*') }
+
+    it 'starts a get request with the correct path' do
+      allow(RedmineClient::Issue).to receive(:new)
+      expect(RedmineClient::Issue).
+        to receive(:get).with('/issues.json', query: { subject: 'nice subject', status_id: '*'}).
+        and_return double(ok?: true, :[] => [])
+      subject
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'redmine_client'
+
+RedmineClient::API.configure do |config|
+  config.url = 'http://redmine.test'
+  config.token = 'abcd'
+end
+
+require 'pry'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f}
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: nine-redmine-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- nine.ch Development-Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-14 00:00:00.000000000 Z
+dependencies:
+- !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: pry
+  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: httparty
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: To access the Redmine API from ruby scripts.
+email:
+- development@nine.ch
+executables:
+- nine-redmine-client
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- bin/nine-redmine-client
+- gemfiles/activesupport-4.0.gemfile
+- gemfiles/activesupport-4.1.gemfile
+- gemfiles/activesupport-4.2.gemfile
+- lib/nine-redmine-client.rb
+- lib/redmine_client.rb
+- lib/redmine_client/api.rb
+- lib/redmine_client/base.rb
+- lib/redmine_client/errors.rb
+- lib/redmine_client/issue.rb
+- nine-redmine-client.gemspec
+- spec/redmine_client/base_spec.rb
+- spec/redmine_client/issue_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ninech/
+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.1
+signing_key: 
+specification_version: 4
+summary: Redmine API ruby client library
+test_files: []