backlog_api 0.0.1

data/lib/data/api_methods.yml

@@ -0,0 +1,148 @@
+getProjects:
+  type: null
+  required: []
+  not_required: []
+  return_type: Array
+  desc: '参加プロジェクトを配列で返します。指定できるパラメータはありません。'
+getProject:
+  type: scalar
+  required: [projectKey]
+  desc: 'プロジェクトキーを指定して、プロジェクトを取得します。'
+# getProject:
+#   type: scalar
+#   required: [projectId]
+#   desc: 'プロジェクトIDを指定して、プロジェクトを取得します。'
+getComponents:
+  type: scalar
+  required: [projectId]
+  desc: 'プロジェクトのカテゴリを返します。'
+getVersions:
+  type: scalar
+  required: [projectId]
+  desc: 'プロジェクトの発生バージョン/マイルストーンを返します。'
+getUsers:
+  type: scalar
+  required: [projectId]
+  desc: 'プロジェクトの参加メンバーを返します。'
+getIssueTypes:
+  type: scalar
+  required: [projectId]
+  desc: 'プロジェクトの種別を返します。'
+# getIssue:
+#   type: scalar
+#   required: [issueKey]
+#   desc: '課題キーを指定して、課題を取得します。'
+getIssue:
+  type: scalar
+  required: [issueId]
+  desc: '課題IDを指定して、課題を取得します。'
+getComments:
+  type: scalar
+  required: [issueId]
+  desc: '課題のコメントを返します。'
+countIssue:
+  type: struct
+  required: [projectId]
+  desc: '指定した条件に該当する課題件数を返します。'
+findIssue:
+  type: struct
+  required: [projectId]
+  desc: '指定した条件に該当する課題を返します。'
+createIssue:
+  type: struct
+  required: [projectId, summary]
+  desc: '課題を追加します。'
+updateIssue:
+  type: struct
+  required: [key]
+  desc: '課題を更新します。'
+switchStatus:
+  type: struct
+  required: [key, statusId]
+  desc: '課題の状態を変更します。'
+addComment:
+  type: struct
+  required: [key, content]
+  desc: '課題にコメントを追加します。'
+addIssueType:
+  type: struct
+  required: [project_id, name, color]
+  desc: 'プロジェクトの課題種別を追加します。'
+updateIssueType:
+  type: struct
+  required: [id, name, color]
+  desc: 'プロジェクトの課題種別を更新します。'
+deleteIssueType:
+  type: struct
+#  required: [id, substitute_id]
+  required: [id]
+  desc: 'プロジェクトの課題種別を削除します。'
+addVersion:
+  type: struct
+  required: [project_id, name]
+  desc: 'プロジェクトの発生バージョン/マイルストーンを追加します。'
+updateVersion:
+  type: struct
+  required: [id, name]
+  desc: 'プロジェクトの発生バージョン/マイルストーンを更新します。'
+# deleteVersion:
+#   type: scalor
+#   required: [id]
+#   desc: 'プロジェクトの発生バージョン/マイルストーンを削除します。'
+# addComponent:
+#   type: struct
+#   required: [project_id, name]
+#   desc: 'プロジェクトのカテゴリを追加します。'
+# updateComponent:
+#   type: struct
+#   required: [id, name]
+#   desc: 'プロジェクトのカテゴリを更新します。'
+# deleteComponent:
+#   type: struct
+#   required: [id]
+#   desc: 'プロジェクトのカテゴリを削除します。'
+getTimeline:
+  type: struct
+  required: []
+  desc: '参加プロジェクトすべての課題の更新情報を配列で返します(最大50件)。'
+getProjectSummary:
+  type: scalar
+  required: [projectId]
+  desc: 'プロジェクト状況を取得します。'
+getProjectSummaries:
+  type: null
+  required: []
+  desc: '全ての参加プロジェクト状況を取得します。'
+# getUser:
+#   type: scalar
+#   required: [id]
+#   desc: 'ユーザID(数値またはログインID)を指定して、ユーザを取得します。'
+# getUserIcon:
+#   type: scalar
+#   required: [id]
+#   desc: 'ユーザID(数値またはログインID)を指定して、ユーザのアイコン画像を取得します。'
+getActivityTypes:
+  type: null
+  required: []
+  desc: '課題の更新情報の種別一覧を取得します。'
+getStatuses:
+  type: null
+  required: []
+  desc: '課題の状態一覧を取得します。'
+getResolutions:
+  type: null
+  required: []
+  desc: '課題の完了理由一覧を取得します。'
+getPriorities:
+  type: null
+  required: []
+  desc: '課題の優先度一覧を取得します。'
+# getCustomFields:
+#   type: struct
+#   required: [projectId]
+#   desc: 'プロジェクトに登録してあるカスタム属性の情報を取得します。'
+# getChildIssues:
+#   type: struct
+#   required: [parent_issue_id]
+#   desc: '指定した親課題のIDの子課題を返します。'
+

data/lib/views/index.erb

@@ -0,0 +1 @@
+インラインテンプレートを使用してね

data/spec/lib/application_spec.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+#ENV['RACK_ENV'] = 'test'
+
+# ドライバ
+# Capybara.register_driver :my_selenium do |app|
+#   Capybara::Selenium::Driver.new(app, :browser => :firefox)
+# end
+# Capybara.default_driver = :my_selenium
+# Capybara.javascript_driver = :my_selenium
+Capybara.default_driver = :webkit
+Capybara.javascript_driver = :webkit
+
+include Capybara::DSL
+
+# Sinatraアプリ起動
+def setup
+  # classicスタイルの場合、Sinatra::Application.newがアプリインスタンスになる
+  Capybara.app = Sinatra::Application.new
+end
+
+describe '/test' do
+  before { setup }
+
+  it do
+    visit '/test'
+    expect(page).to have_content('test')
+  end
+end
+
+
+describe '/' do
+  before { setup }
+
+  it do
+    pending
+    visit '/'    
+  end
+end
+

data/spec/lib/backlog_api/client_spec.rb

@@ -0,0 +1,392 @@
+# -*- coding: utf-8 -*-
+require_relative '../../spec_helper' # このファイルからの相対パス
+
+module BacklogApi
+
+  WebMock.allow_net_connect! # 指定URL以外のアクセスはok by webmock
+  HOST = '%s.backlog.jp'
+
+  describe Client do
+    
+    subject { Client.new }
+
+    # letはitの度に生成されるよ。letは遅延評価でlet!は即評価だよ
+    let(:url) { 'https://%s%s' % [subject.host, Client::PATH]} 
+    
+    # for vcr
+    let(:opt) { {record: :new_episodes} }
+    let(:path) {example.metadata[:full_description].split(/\s+/, 2).join("/").underscore.gsub(/[^\w\/]+/, "_")}
+
+    # for backlog_api's key
+    let(:project_key) {ENV['BACKLOG_PROJECTKEY'] }
+    let(:project_id) {ENV['BACKLOG_PROJECTID'].to_i}
+    let(:issue_key) {ENV['BACKLOG_ISSUEKEY']} 
+    let(:issue_id) {ENV['BACKLOG_ISSUEID'].to_i} 
+    let(:summary) {ENV['BACKLOG_SUMMARY']} 
+    let(:key) {ENV['BACKLOG_KEY']} 
+    let(:status_id) {ENV['BACKLOG_STATUSID'].to_i} 
+    let(:name) {ENV['BACKLOG_NAME']} 
+    let(:color) {ENV['BACKLOG_COLOR']} 
+    let(:substitute_id) {ENV['BACKLOG_SUBSTITUTE_ID'].to_i} 
+    let(:id) {ENV['BACKLOG_ID'].to_i} 
+    let(:parent_issue_id) {ENV['BACKLOG_PARENTISSUEID'].to_i} 
+    let(:project_name) {ENV['BACKLOG_PROJECTNAME']} 
+    let(:category_name) {ENV['BACKLOG_CATEGORYNAME']} 
+    let(:project_id2) {ENV['BACKLOG_PROJECTID2'].to_i} 
+    let(:user_id) {ENV['BACKLOG_USERID'].to_i} 
+
+    METHOD = 'backlog.%s'
+
+    describe '#get_projects' do
+      it do
+        VCR.use_cassette(path, opt) do # vcrのキャッシュ
+          expect(subject.get_projects).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_project' do
+      it do
+        VCR.use_cassette(path, opt) do # vcrのキャッシュ
+          expect(subject.get_project(project_key)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#get_components' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_components(project_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_versions' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_versions(project_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_users' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_users(project_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_issue_types' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_issue_types(project_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_issue' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_issue(project_id)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#get_users' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_users(project_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_issue' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_issue(issue_id)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#get_comments' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_comments(issue_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#count_issue' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.count_issue(projectId: project_id)).to be_a(Integer)
+        end
+      end
+    end
+
+    describe '#find_issue' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.find_issue(projectId: project_id)).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#create_issue' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(
+            subject.create_issue(
+              projectId: project_id,
+              summary: summary,
+              )
+            ).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#update_issue' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.update_issue(key: key)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#switch_status' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.switch_status(key: key, statusId: status_id)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#add_issue_type' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(
+            subject.add_issue_type(
+              project_id: project_id,
+              name: name,
+              color: color, 
+              )
+            ).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#update_issue_type' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(
+            subject.update_issue_type(
+              id: id,
+              name: name,
+              color: color, 
+              )              
+            ).to be_a(Hash)
+        end
+      end
+    end
+
+
+    describe '#delete_issue_type' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(
+            subject.delete_issue_type(
+              id: id,
+              )              
+            ).to be_a(Hash)
+        end
+      end
+    end
+
+
+    describe '#add_version' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(
+            subject.add_version(
+              project_id: project_id,
+              name: project_name
+              )
+            ).to be_a(Hash)
+        end
+      end
+    end
+
+
+    describe '#update_version' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.update_version(id: project_id, name: project_name)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#get_timeline' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_timeline).to be_a(Array)
+        end
+      end
+    end
+
+
+    describe '#get_project_summary' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_project_summary(project_id)).to be_a(Hash)
+        end
+      end
+    end
+
+    describe '#get_statuses' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_statuses).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_resolutions' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_resolutions).to be_a(Array)
+        end
+      end
+    end
+
+    describe '#get_priorities' do
+      it do
+        VCR.use_cassette(path, opt) do
+          expect(subject.get_priorities).to be_a(Array)
+        end
+      end
+    end
+
+ 
+
+
+    # describe "#get_project" do
+    #   it do
+    #     request_body = '<data projectId="projectId" />'
+    #     response_body = {
+    #       "use_parent_child_issue" => true,
+    #       "id" => 1,
+    #       "text_formatting_rule" => "backlog",
+    #       "archived" => false,
+    #       "name" => "name",
+    #       "url" => "url",
+    #       "key" => "key"}          
+    #     WebMock
+    #       .stub_request(:post, url) # url
+    #       .with(body: request_body, content_type: 'application/xml') # request
+    #       .to_return(status: 200, body: response_body, headers: {}) # response
+    #     expect(subject.get_project("projectId" => "projectID")).to be_a(Hash) # webmock
+        
+    #     expect(subject.get_project("2014YC")).to be_a(Hash) # webmock
+    #   end
+    # end
+
+    # describe "#get_components" do
+    #   it do
+    #             pending
+    #     request_body = 1
+    #     response_body = [
+    #       {"id"=>2, "name"=>"name1"},
+    #       {"id"=>3, "name"=>"name2"}
+    #     ]
+    #     WebMock
+    #       .stub_request(:post, url) # url
+    #       .with(body: request_body, headers: {}) # request
+    #       .to_return(status: 200, body: response_body, headers: {}) # response
+    #     expect(subject.get_components(1)).to be_a(Array) # webmock
+    #   end
+    # end
+
+    
+    describe '#new' do
+      it do
+        expect(subject).to be_an_instance_of Client # instance_of(直接のインスタンス)
+      end
+    end
+
+
+    # ====================================================
+    # private
+    # ====================================================
+    describe '#call' do
+      it do
+        VCR.use_cassette(path, opt) do
+          response = subject.send :call, METHOD % "getProjects"
+          expect(response).to be_a Array
+        end
+      end
+    end
+
+    describe '#login_from_args' do
+      subject { Client.allocate }
+      context '成功時' do
+        it do        
+          subject.send :login_from_args, "a", "b", "c"
+          expect(subject.user).to eq "a"
+          expect(subject.password).to eq "b" 
+          expect(subject.space).to eq "c"
+          expect(subject.host).to eq(HOST % "c")
+        end
+      end
+
+      context '失敗時' do
+        it do
+          subject.send :login_from_args, "a", "b"
+          expect(subject.user).to be_nil
+          expect(subject.password).to be_nil
+          expect(subject.space).to be_nil
+          expect(subject.host).to be_nil
+        end
+      end
+    end
+
+    # # :TODO だめだー修正だー
+    # describe '#login_from_netrc' do
+    #   it do
+    #     subject.send :login_from_netrc
+    #     expect(subject.user).not_to be_nil # nil?
+    #   end
+    # end
+
+    # # :TODO これもだめ。めちゃくちゃ
+    # describe '#login_from_environment_variables' do      
+    #   context '環境変数がセットされている場合は' do
+    #     it do
+    #       ENV["BACKLOG_USER"], ENV["BACKLOG_PASSWORD"],ENV["BACKLOG_SPACE"] = "a", "b", "c"
+    #       subject = Client.new
+    #       subject.send :login_from_environment_variables
+    #       expect(subject.user).not_to be_nil
+    #     end  
+    #   end
+    #   context '環境変数がセットされていない場合は' do
+    #     it do
+    #       ENV["BACKLOG_USER"], ENV["BACKLOG_PASSWORD"],ENV["BACKLOG_SPACE"] = nil, nil, nil
+    #       subject = Client.new
+    #       subject.send :login_from_environment_variables
+    #       expect(subject.user).to be_nil
+    #     end  
+    #   end
+    # end
+
+
+
+
+
+
+
+
+    
+    
+    
+  end # describe
+end # module

data/spec/lib/backlog_api/comand_spec.rb

@@ -0,0 +1,7 @@
+# -*- coding: utf-8 -*-
+require_relative '../../spec_helper'
+# とっぷもじゅーる
+module BacklogApi 
+  describe Command do
+  end
+end

data/spec/lib/backlog_api/command_spec.rb

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+require_relative '../../spec_helper'
+
+PROJECT_ID = ENV['BACKLOG_PROJECTID2'].to_i
+
+module BacklogApi
+  describe Command do
+    subject { Command.new }
+
+    # =============================
+    # private
+    # =============================
+    describe '#group_issues_by_assigner' do
+
+      
+      let(:issues) do
+        # :TODO mock使うように修正
+        [
+          {
+            "status"=>{"id"=>4, "name"=>"完了"},
+            "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"},
+          },
+          {
+            "status"=>{"id"=>4, "name"=>"完了"},
+            "assigner"=>{"id"=>100000001, "name"=>"山田　花子"},
+          },
+        ]
+      end
+      
+      it do
+        grouped_issues = subject.send :group_issues_by_assigner, issues
+        expect(grouped_issues.tapp).to have(2).members
+        expect(grouped_issues.keys).to eq ["山田　太郎", "山田　花子"]
+      end
+    end
+
+    
+    describe '#progress_rate' do
+      context '全て完了している時' do
+        it do
+          issues = 
+            [{"status"=>{"id"=>4, "name"=>"完了"},
+              "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}}]
+          
+          progress_rate = subject.send :progress_rate, issues
+          expect(progress_rate).to eq "100%"        
+        end
+      end
+      context '1/2完了している時' do
+        it do
+          issues = 
+            [{"status"=>{"id"=>4, "name"=>"完了"},
+              "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}},
+            {"status"=>{"id"=>1, "name"=>"作業中"},
+              "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}}]
+          
+          progress_rate = subject.send :progress_rate, issues
+          expect(progress_rate).to eq "50%"
+        end
+      end
+    end
+
+    describe '#completed_count_per_total_count' do
+      context '全て完了している時' do
+        it do
+          issues = 
+            [{"status"=>{"id"=>4, "name"=>"完了"},
+              "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}}]
+          
+          progress_rate = subject.send :completed_count_per_total_count, issues
+          expect(progress_rate).to eq "1/1"        
+        end
+      end
+      context '1/2完了している時' do
+        it do
+          issues = 
+            [{"status"=>{"id"=>4, "name"=>"完了"},
+              "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}},
+            {"status"=>{"id"=>1, "name"=>"作業中"},
+              "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}}]
+          
+          progress_rate = subject.send :completed_count_per_total_count, issues
+          expect(progress_rate).to eq "1/2"
+        end
+      end      
+    end
+
+    describe '#progress_bar' do
+      it do
+        issues = 
+          [{"status"=>{"id"=>4, "name"=>"完了"},
+            "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}},
+          {"status"=>{"id"=>3, "name"=>"処理済み"},
+            "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}},
+          {"status"=>{"id"=>2, "name"=>"処理中"},
+            "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}},
+          {"status"=>{"id"=>1, "name"=>"未対応"},
+            "assigner"=>{"id"=>100000000, "name"=>"山田　太郎"}}
+        ]
+        progress_bar = subject.send :progress_bar, issues
+        expect(progress_bar).to eq("|".blue + "|".green + "|".yellow + "|".red )
+      end
+    end
+
+  end
+end

data/spec/lib/backlog_api/const_spec.rb

@@ -0,0 +1,9 @@
+require_relative '../../spec_helper'
+
+module BacklogApi
+  # describe API_METHODS do
+  # end
+end
+
+
+