backlog-api 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rake', '0.8.7'
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 yoppi
+
+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,22 @@
+# backlog-api
+A library to Easy Access Backlog(http://www.backlog.jp) API from Ruby.
+
+## Installation
+Ok, you just type
+
+    $ gem install backlog-api
+
+## How to use
+First, create backlog client to accessing API.
+Second, call API
+
+    require 'backlog-api'
+    backlog = Backlog::Client.new("space", "user", "password")
+    # get Project List
+    projects = backlog.get_projects()
+    # get Issue
+    issue = backlog.get_issue("issue_key")
+ 
+## Copyright
+Copyright (c) 2011 yoppi. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "backlog-api"
+  gem.homepage = "http://github.com/yoppi/backlog-api"
+  gem.license = "MIT"
+  gem.summary = %Q{Backlog API}
+  gem.description = %Q{A library to Access Backlog Issue from Ruby}
+  gem.email = "y.hirokazu@gmail.com"
+  gem.authors = ["yoppi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backlog-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/backlog-api.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backlog-api}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{yoppi}]
+  s.date = %q{2011-10-09}
+  s.description = %q{A library to Access Backlog Issue from Ruby}
+  s.email = %q{y.hirokazu@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "backlog-api.gemspec",
+    "lib/backlog.rb",
+    "lib/backlog/api.rb",
+    "lib/backlog/client.rb",
+    "lib/backlog/object.rb",
+    "spec/backlog/api_spec.rb",
+    "spec/backlog/client_spec.rb",
+    "spec/backlog/object_spec.rb",
+    "spec/backlog_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/yoppi/backlog-api}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
+  s.summary = %q{Backlog API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, ["= 0.8.7"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["= 0.8.7"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/backlog.rb

@@ -0,0 +1,9 @@
+# coding: utf-8
+
+$:.unshift File.join(File.dirname(__FILE__))
+
+module Backlog
+  require 'backlog/api'
+  require 'backlog/object'
+  require 'backlog/client'
+end

data/lib/backlog/api.rb

@@ -0,0 +1,132 @@
+# coding: utf-8
+
+module Backlog
+  module API
+    class ArgumentError < StandardError ; end
+
+    def get_projects
+      self.call("backlog.getProjects").map {|project|
+        Backlog::Object::Project.new(project)
+      }
+    end
+
+    # String | Integer -> Backlog::Object::Project
+    def get_project(project_key)
+      Backlog::Object::Project.new(
+        self.call("backlog.getProject", conv_str_to_int(project_key))
+      )
+    end
+
+    def get_components(project_id)
+      self.call("backlog.getComponents", project_id).map {|component|
+        Backlog::Object::Component.new(component)
+      }
+    end
+
+    def get_versions(project_id)
+      self.call("backlog.getVersions", project_id).map {|version|
+        Backlog::Object::Version.new(version)
+      }
+    end
+
+    def get_users(project_id)
+      self.call("backlog.getUsers", project_id).map {|user|
+        Backlog::Object::User.new(user)
+      }
+    end
+
+    # String | Integer -> Backlog::Object::DetailUser
+    def get_user(user_key)
+      Backlog::Object::DetailUser.new(
+        self.call("backlog.getUser", conv_str_to_int(user_key))
+      )
+    end
+
+    # String | Integer -> Backlog::Object::UserIcon
+    def get_user_icon(user_key)
+      Backlog::Object::UserIcon.new(
+        self.call("backlog.getUserIcon", conv_str_to_int(user_key))
+      )
+    end
+
+    def get_issue_types(project_id)
+      self.call("backlog.getIssueTypes", project_id).map {|issue_type|
+        Backlog::Object::IssueType.new(issue_type)
+      }
+    end
+
+    # String | Integer -> Backlog::Object::Issue
+    def get_issue(issue_key)
+      Backlog::Object::Issue.new(
+        self.call("backlog.getIssue", conv_str_to_int(issue_key))
+      )
+    end
+
+    def get_comments(issue_id)
+      self.call("backlog.getComments", issue_id).map {|comment|
+        Backlog::Object::Comment.new(comment)
+      }
+    end
+
+    def get_timeline
+      self.call("backlog.getTimeline").map {|timeline|
+        Backlog::Object::Timeline.new(timeline)
+      }
+    end
+
+    def get_activity_types
+      self.call("backlog.getActivityTypes").map {|activity_type|
+        Backlog::Object::ActivityType.new(activity_type)
+      }
+    end
+
+    def get_statuses
+      self.call("backlog.getStatuses").map {|status|
+        Backlog::Object::Status.new(status)
+      }
+    end
+
+    def get_resolutions
+      self.call("backlog.getResolutions").map {|resolution|
+        Backlog::Object::Resolution.new(resolution)
+      }
+    end
+
+    def get_priorities
+      self.call("backlog.getPriorities").map {|priority|
+        Backlog::Object::Priority.new(priority)
+      }
+    end
+
+    # Integer -> (String|Integer) -> Backlog::Object::CustomFields
+    def get_custom_fields(project_id, issue_type=nil)
+      h = {"project_id" => project_id}
+      if issue_type.instance_of? String
+        h["issue_type"] = issue_type
+      elsif issue_type.instance_of? Integer
+        h["issue_type_id"] = isuissue_type
+      end
+      self.call("backlog.getCustomFields", h).map {|custom_field|
+        Backlog::Object::CustomField.new(custom_field)
+      }
+    end
+
+    # Hash -> Integer
+    def count_issue(condition)
+      raise Backlog::API::ArgumentError, "must specify 'projectId'" unless condition.has_key? "projectId"
+      condition = Backlog::Object::FindCondition.new(condition)
+      self.call("backlog.countIssue", condition.to_h)
+    end
+
+    # String(Integer) -> Integer
+    # String(String) -> String
+    # Integer -> Integer
+    def conv_str_to_int(x)
+      if x.instance_of? String
+        (x.to_i.zero? && x != "0") ? x : x.to_i
+      else
+        x
+      end
+    end
+  end
+end

data/lib/backlog/client.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'xmlrpc/client'
+
+module Backlog
+  class Client
+    include API
+
+    BACKLOG_API = "https://%s:%s@%s.backlog.jp/XML-RPC"
+
+    def initialize(space, username, password)
+      @space = space
+      @username = username
+      @password = password
+      @client = XMLRPC::Client.new2(BACKLOG_API % [@username, @password, @space])
+    end
+    attr_reader :space, :username, :password, :client
+
+    def call(method, args=nil)
+      if args
+        @client.call(method, args)
+      else
+        @client.call(method)
+      end
+    end
+  end
+end

data/lib/backlog/object.rb

@@ -0,0 +1,247 @@
+# coding: utf-8
+
+module Backlog
+  module Object
+    class Serializable
+      def to_h
+        self.instance_variables.inject({}) {|ret, v|
+          ret[v.to_s.gsub(/^@/, '')] = self.instance_variable_get(v.to_s)
+          ret
+        }
+      end
+    end
+
+    class Project
+      def initialize(project)
+        @id = project['id']
+        @name = project['name']
+        @key = project['key']
+        @url = project['url']
+        @archived = project['archived']
+      end
+      attr_reader :id, :name, :key, :url, :archived
+    end
+
+    class Component
+      def initialize(component)
+        @id = component['id']
+        @name = component['name']
+      end
+      attr_reader :id, :name
+    end
+
+    class Version
+      def initialize(version)
+        @id = version['id']
+        @name = version['name']
+        @date = version['date']
+      end
+      attr_reader :id, :name, :date
+    end
+
+    class User
+      def initialize(user)
+        @id = user['id']
+        @name = user['name']
+      end
+      attr_reader :id, :name
+    end
+
+    class DetailUser < User
+      def initialize(user)
+        super(user)
+        @lang = user['lang']
+        @updated_on = user['updated_on']
+      end
+      attr_reader :lang, :updated_on
+    end
+
+    class UserIcon
+      def initialize(user_icon)
+        @id = user_icon['id']
+        @content_type = user_icon['content_type']
+        # backlog.getUserIcon['data'] isn't encoded, so encode here.
+        @data = XMLRPC::Base64.encode(user_icon['data']).delete("\n")
+        @updated_on = user_icon['updated_on']
+      end
+      attr_reader :id, :content_type, :data, :updated_on
+    end
+
+    class IssueType
+      def initialize(issue_type)
+        @id = issue_type['id']
+        @name = issue_type['name']
+        @color = issue_type['color']
+      end
+      attr_reader :id, :name, :color
+    end
+
+    class Issue
+      def initialize(issue)
+        @id = issue['id']
+        @key = issue['key']
+        @summary = issue['summary']
+        @description = issue['description']
+        @url = issue['url']
+        @due_date = issue['due_date']
+        @start_date = issue['start_date'],
+        @estimated_hours = issue['estimated_hours']
+        @actual_hours = issue['actual_hours']
+        @issue_type = issue['issue_type'] ? IssueType.new(issue['issue_type']) : nil
+        @priority = issue['priority'] ? Priority.new(issue['priority']) : nil
+        @resolution = issue['resolution'] ? Resolution.new(issue['resolution']) : nil
+        @status = issue['status'] ? Status.new(issue['status']) : nil
+        @components = issue['components'] ? issue['components'].map {|x| Component.new(x) } : []
+        @versions = issue['versions'] ? issue['versions'].map {|x| Version.new(x) } : []
+        @milestones = issue['milestone'] ? issue['milestones'].map {|x| Milestone.new(x)} : []
+        @created_user = issue['created_user'] ? User.new(issue['created_user']) : nil
+        @assigner = issue['assigner'] ? User.new(issue['assigner']) : nil
+        @created_on = issue['created_on']
+        @updated_on = issue['updated_on']
+        @custom_fields = issue['custom_fields']
+      end
+      attr_reader :id, :key, :summary, :description, :url,
+                  :due_date, :start_date, :estimated_hours,
+                  :actual_hours, :issue_type, :priority,
+                  :resolution, :status, :components, :versions,
+                  :milestones, :created_user, :assigner,
+                  :created_on, :updated_on, :custom_fields
+    end
+
+    class Priority
+      def initialize(priority)
+        @id = priority['id']
+        @name = priority['name']
+      end
+      attr_reader :id, :name
+    end
+
+    class Resolution
+      def initialize(resolution)
+        @id = resolution['id']
+        @name = resolution['name']
+      end
+      attr_reader :id, :name
+    end
+
+    class Status
+      def initialize(status)
+        @id = status['id']
+        @name = status['name']
+      end
+      attr_reader :id, :name
+    end
+
+    class Item
+      def initialize(item)
+        @id = item['id']
+        @name = item['name']
+      end
+    end
+
+    class Milestone
+      def initialize(milestone)
+        @id = milestone['id']
+        @name = milestone['name']
+        @date = milestone['date']
+      end
+      attr_reader :id, :name, :date
+    end
+
+    class Comment
+      def initialize(comment)
+        @id = comment['id']
+        @content = comment['content']
+        @created_user = User.new(comment['created_user'])
+        @created_on = comment['created_on']
+        @updated_on = comment['updated_on']
+      end
+      attr_reader :id, :content, :created_user, :created_on, :updated_on
+    end
+
+    class Timeline
+      def initialize(timeline)
+        @type = timeline['type'] ? ActivityType.new(timeline['type']) : nil
+        @content = timeline['content']
+        @updated_on = timeline['updated_on']
+        @user = timeline['user'] ? User.new(timeline['user']) : nil
+        @issue = timeline['issue'] ? Issue.new(timeline['issue']) : nil
+      end
+      attr_reader :type, :content, :updated_on, :user, :issue
+    end
+
+    class ActivityType
+      def initialize(activity_type)
+        @id = activity_type['id']
+        @name = activity_type['name']
+      end
+      attr_reader :id, :name
+    end
+
+    class CustomField
+      def initialize(custom_field)
+        @id = custom_field['id']
+        @type_id = custom_field['type_id']
+        @name = custom_field['name']
+        @description = custom_field['description']
+        @required = custom_field['required']
+        if custom_field['issue_types']
+          @issue_types = custom_field['issue_types'].map {|issue_type| IssueType.new(issue_type) }
+        end
+        # custom_field type is Number(type_id = 3)
+        @min = custom_field['min']
+        @max = custom_field['max']
+        @initial_value = custom_field['initial_value']
+        @unit = custom_field['unit']
+        # custom_field type is Date(type_id = 4)
+        @initial_value_type = custom_field['initial_value_type']
+        @initial_shift = custom_field['initial_shift']
+        @initial_date = custom_field['initial_date']
+        # custom_field type is List(type_id = 5,6)
+        if custom_field['items']
+          @items = custom_field['items'].map {|item| Item.new(item)}
+        end
+        # custom_field type is CheckBox or RadioButton(type_id = 7,8)
+        @allow_input = custom_field['allow_input']
+      end
+      attr_reader :id, :type_id, :name, :description, :required,
+                  :issue_types,
+                  :min, :max, :initial_value, :unit,
+                  :initial_value_type, :initial_shift, :initial_date,
+                  :items,
+                  :allow_input
+    end
+
+    class FindCondition < Serializable
+      CONDITION_KEYS = %w[
+        projectId
+        issueTypeId
+        issueType
+        componentId
+        versionId
+        milestoneId
+        statusId
+        priorityId
+        assignerId
+        createdUserId
+        resolutionId
+        created_on_min
+        created_on_max
+        updated_on_min
+        updated_on_max
+      ].each {|k|
+        class_eval { attr_reader k.to_sym }
+      }
+
+      def initialize(condition)
+        condition.each {|k, v|
+          self.instance_eval %Q{
+            if CONDITION_KEYS.include? k
+              @#{k} = v
+            end
+          }
+        }
+      end
+    end
+  end
+end

data/spec/backlog/api_spec.rb

@@ -0,0 +1,519 @@
+# coding: utf-8
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Backlog::API do
+  before(:each) do
+    @client = Backlog::Client.new("hoge", "yoppi", "test")
+  end
+
+  describe "プロジェクトAPI" do
+    context "プロジェクトの一覧を取得する" do
+      let(:projects) {
+        [{"id" => 100,
+          "name" => "test",
+          "key" => "TEST",
+          "url" => "http://hoge.backlog.jp/TEST",
+          "archived" => false}]
+      }
+
+      before do
+        mock(@client).call.with_any_args { projects }
+      end
+
+      it "プロジェクトのリストを取得できる" do
+        @client.get_projects.class.should == Array
+      end
+    end
+
+    context "プロジェクトを取得する" do
+      let(:project) {
+        {"id" => 100,
+          "name" => "test",
+          "key" => "TEST",
+          "url" => "http://hoge.backlog.jp/TEST",
+          "archived" => false}
+      }
+
+      before do
+        mock(@client).call.with_any_args { project }
+      end
+
+      it "project_idを指定してプロジェクトを取得できる" do
+        @client.get_project(100).class.should == Backlog::Object::Project
+      end
+
+      it "keyを指定してプロジェクトを取得できる" do
+        @client.get_project("key").class.should == Backlog::Object::Project
+      end
+    end
+  end
+
+  describe "カテゴリAPI" do
+    context "プロジェクトのカテゴリを取得する" do
+      let(:component) {
+        [{"id" => 100,
+          "name" => "カテゴリ名"}]
+      }
+
+      before do
+        mock(@client).call.with_any_args { component }
+      end
+
+      it "指定したプロジェクトのカテゴリが取得できる" do
+        @client.get_components(100).class.should == Array
+      end
+
+      it "取得したカテゴリはすべてカテゴリオブジェクトである" do
+        @client.get_components(100).each {|component|
+          component.class.should == Backlog::Object::Component
+        }
+      end
+    end
+  end
+
+  describe "バージョンAPI" do
+    context "プロジェクトの発生バージョン/マイルストーンを取得する" do
+      let(:version) {
+        [{"id" => 733,
+          "name" => "サイトオープン",
+          "date" => "20110808"}]
+      }
+
+      before do
+        mock(@client).call.with_any_args { version }
+      end
+
+      it "プロジェクトを指定して発生バージョンが取得できる" do
+        @client.get_versions(100).class.should == Array
+      end
+    end
+  end
+
+  describe "ユーザAPI" do
+    context "プロジェクトの参加メンバーを取得する" do
+      let(:user) {
+        [{"id" => 1000,
+          "name" => "yoppi"}]
+      }
+
+      before do
+        mock(@client).call.with_any_args{ user }
+      end
+
+      it "プロジェクトを指定してその参加メンバーを取得できる" do
+        @client.get_users(100).class.should == Array
+      end
+    end
+
+    context "特定のユーザの情報を取得する" do
+      let(:user) {
+        {"id" => 1000,
+         "name" => "yoppi",
+         "lang" => "ja",
+         "updated_on" => "20110807220000"}
+      }
+
+      before do
+        mock(@client).call.with_any_args { user }
+      end
+
+      it "ユーザIDを指定してそのユーザの情報を取得する" do
+        @client.get_user(100).class.should == Backlog::Object::DetailUser
+      end
+    end
+
+    context "特定のユーザのアイコンを取得する" do
+      let(:user_icon) {
+        {
+          "id" => 1000,
+          "content_type" => "image/gif",
+          "data" => "/9j/4AAQSkZJRgABAgAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAAgACADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDMvWNpEHL5ycCo00rV7+NZrOylkjI+WR2VB+GeTVhGjQj7UHlfP7uN+Ax/Ht7f4VPa+OjoupS2GrSRb5pEaKOINiFWHG7PUng8V51SpKWkS8Jg4RSnUMqa11OwkEd9ZmPJwr5DZP1FNMUjA5P4cf4VtJd6rHbyQa1HBcRnMnnRMeUyTg579uPSqTPAw2wENH2yBkd8E06NR35WZ47CRSdSI3QbG28NXD3K3VzdyyZUxTMNiruU9upwDzx19zXPa3px1DxAuoopQZU5LZ6etd/d2EUwIkwy9RkYwayZrRg4KuVRei8VsoPmuc7xb5bET6hBLZGOVH85YNkc0e5eSSWDAHG0/J2zwazrJVt1IjiOPUD7x/OtG437CAcA8deRTYLWadRicmNONoAGP0qPZ8slYcq7qQfMf//Z",
+        }
+      }
+
+      before do
+        mock(@client).call.with_any_args { user_icon }
+      end
+
+      it "ユーザを指定してそのユーザのアイコンが取得できる" do
+        @client.get_user_icon(100).class.should == Backlog::Object::UserIcon
+      end
+    end
+  end
+
+  describe "イシューAPI" do
+    context "プロジェクトのイシュータイプを取得する" do
+      let(:issue_types) {
+        [{"id" => 2000,
+          "name" => "タスク",
+          "color" => "#7ea800"
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { issue_types }
+      end
+
+      it "プロジェクトを指定してそのイシュータイプのリストを取得する" do
+        @client.get_issue_types(100).class.should == Array
+      end
+
+      it "イシュータイプのリスト要素はすべてイシュータイプオブジェクトである" do
+        @client.get_issue_types(100).each {|issue_type|
+          issue_type.class.should == Backlog::Object::IssueType
+        }
+      end
+    end
+
+    context "プロジェクトのイシューを取得する" do
+      let(:issue) {
+        {
+          "id" => 1617103,
+          "key" => "ISSUE-100",
+          "summary" => "トップページのデザイン決定",
+          "description" => "トップページのデザイン決定する",
+          "url" => "https://test.backog.jp/view/ISSUE-100",
+          "due_date" => "20110831",
+          "start_date" => "20110720",
+          "estimated_hours" => "100",
+          "actual_hours" => "200",
+          "issue_type" => {"id" => 2000,
+                           "name" => "タスク",
+                           "color" => "#7ea800"},
+          "priority" => {"id" => 300, "name" => "中"},
+          "resolution" => {"id" => 400, "name" => "対応済み"},
+          "status" => {"id" => 2, "name" => "処理中"},
+          "components" => [{"id" => 100,
+                            "name" => "カテゴリ名"}],
+          "versions" => [{"id" => 733,
+                          "name" => "サイトオープン",
+                          "date" => "20110808"}],
+          "milestones" => [{"id" => 800,
+                            "name" => "8/21リリース",
+                            "date" => "20110821"}],
+          "created_user" => {"id" => 1000, "name" => "yoppi"},
+          "assigner" => {"id" => 1000, "name" => "yoppi"},
+          "created_on" => "20110701",
+          "updated_on" => "20110807",
+          "custom_fields" => []
+        }
+      }
+
+      before do
+        mock(@client).call.with_any_args { issue }
+      end
+
+      it "課題キーを指定してイシューを取得できる" do
+        @client.get_issue("ISSUE-100").class.should == Backlog::Object::Issue
+      end
+    end
+  end
+
+  describe "コメントAPI" do
+    context "イシューのコメントを取得する" do
+      let(:comments) {
+        [{"id" => "12889281",
+          "content" => "ここはもっとシンプルなデザインがいいと思いました。",
+          "created_user" => {"id" => 100, "name" => "yoppi"},
+          "created_on" => "20110808165300",
+          "updated_on" => "20110808165300"
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { comments }
+      end
+
+      it "指定したイシューのコメントが取得できる" do
+        @client.get_comments(1000).class.should == Array
+      end
+    end
+  end
+
+  describe "タイムラインAPI" do
+    context "タイムライン(イシューの更新情報)の一覧を取得する" do
+      let(:timeline) {
+        [{
+          "type" => {"id" => 1, "name" => "更新"},
+          "content" => "着手しました",
+          "updated_on" => "20110807194600",
+          "user" => {"id" => 100, "name" => "yoppi"},
+          "issue" => {"id" => "73", "key" => "ISSUE-100",
+                      "summary" => "トップページのデザイン決定",
+                      "description" => "トップページのデザイン決定します",
+                      "priority" => {"id" => 2, "name" => "中"}}
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { timeline }
+      end
+
+      it "タイムラインの一覧が取得できる" do
+        @client.get_timeline().class.should == Array
+      end
+    end
+  end
+
+  describe "イシューの更新情報の種別一覧API" do
+    let(:activity_types) {
+      [
+        {"id" => 100,
+         "name" => "課題"}
+      ]
+    }
+
+    before do
+      mock(@client).call.with_any_args { activity_types }
+    end
+
+    it "イシューの更新情報の種別一覧を取得できる" do
+      @client.get_activity_types().class.should == Array
+    end
+
+    it "各種別のオブジェクトであること" do
+      @client.get_activity_types().each {|activity_type|
+        activity_type.class.should == Backlog::Object::ActivityType
+      }
+    end
+  end
+
+  describe "イシュー状態API" do
+    let(:statuses) {
+      [{"id" => 4, "name" => "完了"}]
+    }
+
+    before do
+      mock(@client).call.with_any_args { statuses }
+    end
+
+    it "イシューの状態一覧を取得できる" do
+      @client.get_statuses().class.should == Array
+    end
+
+    it "取得したイシューの状態一覧の各状態はStatusオブジェクトであること" do
+      @client.get_statuses().each {|status|
+        status.class.should == Backlog::Object::Status
+      }
+    end
+  end
+
+  describe "イシュー完了理由API" do
+    let(:resolutions) {
+      [{"id" => 0, "name" => "対応済み"}]
+    }
+
+    before do
+      mock(@client).call.with_any_args { resolutions }
+    end
+
+    it "イシューの完了理由一覧を取得できる" do
+      @client.get_resolutions().class.should == Array
+    end
+
+    it "取得したイシューの完了理由一覧はResolutionオブジェクトであること" do
+      @client.get_resolutions().each {|resolution|
+        resolution.class.should == Backlog::Object::Resolution
+      }
+    end
+  end
+
+  describe "イシューの優先度一覧取得API" do
+    let(:priorities) {
+      [{"id" => 3, "name" => "中"}]
+    }
+
+    before do
+      mock(@client).call.with_any_args { priorities }
+    end
+
+    it "イシューの優先度一覧を取得できる" do
+      @client.get_priorities().class.should == Array
+    end
+
+    it "取得したイシューの各優先度はPriorityオブジェクトであること" do
+      @client.get_priorities().each {|priority|
+        priority.class.should == Backlog::Object::Priority
+      }
+    end
+  end
+
+  describe "カスタム属性の情報取得API" do
+    context "カスタム属性タイプが文字列の場合" do
+      let(:custom_fields_1) {
+        [{"id" => 4,
+          "type_id" => 1,
+          "name" => "OS",
+          "description" => "現象が発生したOS",
+          "required" => 1,
+          "issue_types" => [{"id" => 5, "name" => "バグ", "color" => "#990000"}]}]
+      }
+
+      before do
+        mock(@client).call.with_any_args { custom_fields_1 }
+      end
+
+      it "プロジェクトIDを指定して登録しているカスタム属性の情報を取得できる" do
+        @client.get_custom_fields(100).class.should == Array
+      end
+
+      it "プロジェクトIDをissue_type_idを指定して登録しているカスタム属性の情報を取得できる" do
+        @client.get_custom_fields(100, 10).class.should == Array
+      end
+
+      it "プロジェクトIDをissue_typeを指定して登録しているカスタム属性の情報を取得できる" do
+        @client.get_custom_fields(100, "バグ").class.should == Array
+      end
+
+      it "取得したカスタム属性情報はCustomFieldsオブジェクトであること" do
+        @client.get_custom_fields(100).each {|custom_field|
+          custom_field.class.should == Backlog::Object::CustomField
+          custom_field.id.should == custom_fields_1.first["id"]
+          custom_field.type_id.should == custom_fields_1.first["type_id"]
+          custom_field.name.should == custom_fields_1.first["name"]
+          custom_field.description.should == custom_fields_1.first["description"]
+          custom_field.required.should == custom_fields_1.first["required"]
+          custom_field.issue_types.class.should == Array
+          custom_field.issue_types.each {|issue_type|
+            issue_type.class.should == Backlog::Object::IssueType
+            issue_type.id.should == custom_fields_1.first["issue_types"].first["id"]
+            issue_type.name.should == custom_fields_1.first["issue_types"].first["name"]
+            issue_type.color.should == custom_fields_1.first["issue_types"].first["color"]
+          }
+        }
+      end
+    end
+
+    context "カスタム属性タイプが数値の場合" do
+      let(:custom_fields_3) {
+        [{"id" => 10,
+          "type_id" => 3,
+          "name" => "割合",
+          "description" => "発生した割合",
+          "required" => 1,
+          "issue_types" => [{"id" => 5, "name" => "バグ", "color" => "#990000"}],
+          "min" => 0.0,
+          "max" => 100.0,
+          "initial_value" => 0.0,
+          "unit" => "%"
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { custom_fields_3 }
+      end
+
+      it "取得したカスタム属性情報はCustomFieldオブジェクトであること" do
+        @client.get_custom_fields(100).each {|custom_field|
+          custom_field.min.should == custom_fields_3.first["min"]
+          custom_field.max.should == custom_fields_3.first["max"]
+          custom_field.initial_value.should == custom_fields_3.first["initial_value"]
+          custom_field.unit.should == custom_fields_3.first["unit"]
+        }
+      end
+    end
+
+    context "カスタム属性タイプが日付の場合" do
+      let(:custom_fields_4) {
+        [{"id" => 20,
+          "type_id" => 4,
+          "name" => "日付",
+          "description" => "発生した日付",
+          "required" => 1,
+          "issue_types" => [{"id" => 5, "name" => "バグ", "color" => "#990000"}],
+          "initial_value_type" => 1,
+          "min" => 100.0,
+          "max" => 0.0,
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { custom_fields_4 }
+      end
+
+      it "取得したカスタム属性情報はCustomFieldオブジェクトであること" do
+        @client.get_custom_fields(100).each {|custom_field|
+          custom_field.initial_value_type.should == custom_fields_4.first["initial_value_type"]
+          custom_field.min.should == custom_fields_4.first["min"]
+          custom_field.max.should == custom_fields_4.first["max"]
+        }
+      end
+    end
+
+    context "カスタム属性タイプがリストの場合" do
+      let(:custom_fields_5) {
+        [{"id" => 20,
+          "type_id" => 5,
+          "name" => "OS",
+          "description" => "発生したOS",
+          "required" => 1,
+          "issue_types" => [{"id" => 5, "name" => "バグ", "color" => "#990000"}],
+          "items" => [{"id" => 1, "name" => "windows"}]
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { custom_fields_5 }
+      end
+
+      it "取得したカスタム属性情報はCustomFieldオブジェクトであること" do
+        @client.get_custom_fields(100).each {|custom_field|
+          custom_field.items.class == Array
+          custom_field.items.each {|item|
+            item.class.should == Backlog::Object::Item
+          }
+        }
+      end
+    end
+
+    context "カスタム属性タイプがチェックボックスの場合" do
+      let(:custom_fields_7) {
+        [{"id" => 20,
+          "type_id" => 5,
+          "name" => "OS",
+          "description" => "発生したOS",
+          "required" => 1,
+          "issue_types" => [{"id" => 5, "name" => "バグ", "color" => "#990000"}],
+          "allow_input" => "1",
+          "items" => [{"id" => 1, "name" => "windows"}]
+        }]
+      }
+
+      before do
+        mock(@client).call.with_any_args { custom_fields_7 }
+      end
+
+      it "取得したカスタム属性情報はCustomFieldオブジェクトであること" do
+        @client.get_custom_fields(100).each {|custom_field|
+          custom_field.allow_input.should == custom_fields_7.first['allow_input']
+        }
+      end
+    end
+  end
+
+  describe "イシュー件数検索API" do
+    context "クエリにproject_idがない場合" do
+      let(:condition) {
+        {"issueTypeId" => 100}
+      }
+      it "例外が発生する" do
+        expect { @client.count_issue(condition) }.should raise_error(Backlog::API::ArgumentError)
+      end
+    end
+    context "指定した検索条件で検索する" do
+      let(:condition) {
+        {
+          "projectId" => 100,
+          "issueTypeId" => 10
+        }
+      }
+      before do
+        mock(@client).call.with_any_args { 1 }
+      end
+      it "指定した検索条件で検索できる" do
+        @client.count_issue(condition).should == 1
+      end
+    end
+  end
+end

data/spec/backlog/client_spec.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Backlog::Client do
+  context "特定のユーザのプロジェクトでAPIにアクセスする" do
+    let(:space) { 'test' }
+    let(:username) { 'yoppi' }
+    let(:password) { 'hoge' }
+    let(:client) {
+      Backlog::Client.new(space, username, password)
+    }
+
+    it "Backlogにアクセスするクライアントオブジェクトが生成されること" do
+      client.should_not be_nil
+    end
+
+    it "ユーザ名が取得できること" do
+      client.username.should == username
+    end
+
+    it "スペース名が取得できること" do
+      client.space.should == space
+    end
+  end
+end

data/spec/backlog/object_spec.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Backlog::Object::FindCondition do
+  let(:params) {
+    {
+      "projectId" => 100,
+      "issueTypeId" => 10
+    }
+  }
+  it "指定したHashのパラメータが登録されていること" do
+    o = Backlog::Object::FindCondition.new(params)
+    o.projectId.should == params["projectId"]
+    o.issueTypeId.should == params["issueTypeId"]
+  end
+  it "Hashに変換できること" do
+    h = Backlog::Object::FindCondition.new(params).to_h
+    h["projectId"].should == params["projectId"]
+    h["issueTypeId"].should == params["issueTypeId"]
+  end
+end

data/spec/backlog_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Backlog" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'rr'
+require 'pry'
+
+require 'backlog'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: backlog-api
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- yoppi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: A library to Access Backlog Issue from Ruby
+email: y.hirokazu@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- backlog-api.gemspec
+- lib/backlog.rb
+- lib/backlog/api.rb
+- lib/backlog/client.rb
+- lib/backlog/object.rb
+- spec/backlog/api_spec.rb
+- spec/backlog/client_spec.rb
+- spec/backlog/object_spec.rb
+- spec/backlog_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/yoppi/backlog-api
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1065371427
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Backlog API
+test_files: []
+