embulk-input-jira 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c300bb312a6bbf2bfa30a0ed5531e7c3a70a7c4f
+  data.tar.gz: 1cd0319e3794bbde87d9fb82b1d4c9833bb05678
+SHA512:
+  metadata.gz: 73cb22cdbf30f9a43b4d3c3a42d3487064581cb56a6af3fc7c4b3dbd4cd700c5c89979126cbc712da38b1ea588bb6ff0d5ad61675c840e62f8694bb67c73d37f
+  data.tar.gz: 5ad6cf1fbcef9d78c22a1b21f03df1818d856f0a3803cf339aaea0ccf4fbb9bb640c8b30100b5993b3c963eea68ab99d5d2af3ba7e6e8a19f31972ddd6aa2dc3

data/.gitignore

@@ -0,0 +1,7 @@
+*~
+/pkg/
+/tmp/
+/.bundle/
+/Gemfile.lock
+/.ruby-version
+/coverage/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - jruby-19mode
+env:
+  global:
+    secure: "NCkU3f60cn5Gmzq+NwDmKdQSq+ApF/rPqSHPirk1+ZPW9n+H9912meUuJr9qyn03MPdc6wAQinsl3skdPNh1Qz02TI/WZGMiCQTLh3nKIMzaaxx6I+OZ1TV7A4MoJMQ7oYQdXdbvRYXpOVRnfVDxpUC+BDk2T8xmjfm9cht+PGTzM6RxpmSL842hiudkcyxHxgEf66EGpi6h2G2PqYNfQrksqiVMWlLiTO5a2ee+iw9qTMhgKrhEKLCb+dFB56gtKIOpd3MxieLwf3PDcsjM+TSaWo6Bp+mjdA3zGJNz5wbWRVSdrIvKvxmf3eRqAGssBhBDO/LUN3LnI+/T/7J9XZZd7WXNudo/t6HQXhJkUIvOucCxSg8/uRsxrMAmF2zkJOnYGSvN3HNqdzyz86TK4/Xckl+gX51b0uYncHfZYSojn4py1RWPYpX/L2RHbzMn1MJ7B3/VZ21vY97aHhDgNyyAMxPnTAuR1IZicEgA8y8AmZkkK9tWq5wvAOKI91V+W8iBEaO2dZIib+KdJSUUj/Q3TM3i4wX9O/AU7tknsnCApvxQeveELJ4SxfFd/Z2imqmQWM0wIgp1u7Vjguf8kSaxcuQHonZNdwvvYOkbYxHvUqltzlmE1qFC/kQe6o9fS3NuiugHCYVeFs+LXVVW+nl0pWztFYMicUmQq7T781w="
+notifications:
+  slack:
+    secure: QouVFiuH4dTRpjUExfu4NqOYCmt53rmchedTbXqsDXOuLoUbGCMHJgoaYnxJn4Gltqydp8dHXJTE+1hBHZTCGqvO4gng5Z66N7r2DaUk15+mCJPcRl15aMX6J5bXvMp5M7xZYd4AhmB4b3RsdsF4qyH1rf2k9IhakQX09xj1C1OjO3SvMDT/PSQ3cV4mVs4zltYBmNeln9J5rZNexHBg/Mbwz1IqPnR0In5vEUhwBwRc3eo7JoxjBR5/3ffVJcLG1uf9askuW3YacR4XVMYXzFlUErS9QHyugSNTac03YpJmfg8YtY2H1o5ScicwMda3T0nKixHff/Ftkwh7DNsji0edW1WVk+Zt+0P/8ULj/k5gS4uhCERaXNFqRovwqI7is2I1rQFs3TQAQynmXyT0y/jHF0YspTStvuUjSFvuX4P0yaeX39Flih8ZM/js+TkKWjunFsBueqLzcDIjaJ2DFRPi1xDkmwayBhZEpECUE5R19170QsOyIbiG4NFXWWbDIUIapFZKoiohIp46J+NqWYu0Hp/TN6wcqPW7bXVamMma28koM1BLVajW/Ikknqg3Yzf7pzKkRxmoda/fkdfMkr4pqH056YIVKeHKRbrHnfEBArG++HW/T+L8GBW8wH+9fJVeu0G1VsSFH57YARIyO3WF0eqpHB6HHySn2p+DM3Y=
+jdk:
+  - oraclejdk8

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (2015-05-28)
+
+The first release!!

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org/'
+
+# NOTE: Bundler.require(:runtime, :development) in spec_helper that require all dependencies
+#       but require 'embulk' will be failed. so separate it from gemspec ecosystem
+gem 'embulk', ">= 0.6", "< 1.0"
+gem "codeclimate-test-reporter", require: nil
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Everyleaf Corporation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,45 @@
+[![Build Status](https://travis-ci.org/treasure-data/embulk-input-jira.svg)](https://travis-ci.org/treasure-data/embulk-input-jira)
+[![Code Climate](https://codeclimate.com/github/treasure-data/embulk-input-jira/badges/gpa.svg)](https://codeclimate.com/github/treasure-data/embulk-input-jira)
+[![Test Coverage](https://codeclimate.com/github/treasure-data/embulk-input-jira/badges/coverage.svg)](https://codeclimate.com/github/treasure-data/embulk-input-jira/coverage)
+
+# Jira input plugin for Embulk
+
+embulk-input-jira is the Embulk input plugin for [JIRA](https://www.atlassian.com/software/jira).
+
+## Overview
+
+* **Plugin type**: input
+* **Resume supported**: no
+* **Cleanup supported**: no
+* **Guess supported**: yes
+
+## Configuration
+
+- **username** JIRA username (string, required)
+- **password** JIRA password (string, required)
+- **uri** JIRA API endpoint (string, required)
+- **jql** [JQL](https://confluence.atlassian.com/display/JIRA/Advanced+Searching) for extract target issues (string, required)
+- **columns** target issue attributes. You can generate this configuration by `guess` command (array, required)
+
+## Example
+
+```yaml
+in:
+  type: jira
+  username: USERNAME
+  password: PASSWORD
+  uri: http://localhost:8090
+  jql: project = PRO AND summary~Fix
+  columns:
+    - {name: id, type: long}
+    - {name: key, type: string}
+    - {name: project.name, type: string}
+    - {name: summary, type: string}
+    - {name: assignee.name, type: string}
+```
+
+## Build
+
+```
+$ bundle exec rake build
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task default: :spec
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/embulk-input-jira.gemspec

@@ -0,0 +1,22 @@
+
+Gem::Specification.new do |spec|
+  spec.name          = "embulk-input-jira"
+  spec.version       = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors       = ["uu59", "yoshihara"]
+  spec.summary       = "Jira input plugin for Embulk"
+  spec.description   = "Loads records from Jira."
+  spec.email         = ["k@uu59.org", "h.yoshihara@everyleaf.com"]
+  spec.licenses      = ["Apache2"]
+  spec.homepage      = "https://github.com/treasure-data/embulk-input-jira"
+
+  spec.files         = `git ls-files`.split("\n") + Dir["classpath/*.jar"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'jiralicious', ['~> 0.5.0']
+  spec.add_development_dependency 'bundler', ['~> 1.0']
+  spec.add_development_dependency 'rake', ['>= 10.0']
+  spec.add_development_dependency 'rspec', "~> 3.2.0"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'pry'
+end

data/lib/embulk/input/jira-input-plugin-utils.rb

@@ -0,0 +1,36 @@
+# This module contains methods for Plugin.
+
+module Embulk
+  module Input
+    module JiraInputPluginUtils
+      # Guess::SchemaGuess.from_hash_records returns Columns
+      # containing 'index' key, but it is needless.
+      def self.guess_columns(records)
+        schema = Guess::SchemaGuess.from_hash_records(records)
+
+        schema.map do |c|
+          column = {name: c.name, type: c.type}
+          column[:format] = c.format if c.format
+          column
+        end
+      end
+
+      def self.cast(value, type)
+        return value if value.nil?
+
+        case type.to_sym
+        when :long
+          Integer(value)
+        when :double
+          Float(value)
+        when :timestamp
+          Time.parse(value)
+        when :boolean
+          !!value
+        else
+          value.to_s
+        end
+      end
+    end
+  end
+end

data/lib/embulk/input/jira.rb

@@ -0,0 +1,113 @@
+require "embulk/input/jira-input-plugin-utils"
+require "jira/api"
+
+module Embulk
+  module Input
+    class JiraInputPlugin < InputPlugin
+      PER_PAGE = 50
+
+      Plugin.register_input("jira", self)
+
+      def self.version
+        File.read(File.expand_path("../../../../VERSION", __FILE__)).strip
+      end
+
+      def self.transaction(config, &control)
+        task = {
+          "username" => config.param("username", :string),
+          "password" => config.param("password", :string),
+          "uri" => config.param("uri", :string),
+          "jql" => config.param("jql", :string),
+        }
+
+        attributes = {}
+        columns = config.param("columns", :array).map do |column|
+          name = column["name"]
+          type = column["type"].to_sym
+          attributes[name] = type
+          Column.new(nil, name, type, column["format"])
+        end
+
+        task["attributes"] = attributes
+
+        resume(task, columns, 1, &control)
+      end
+
+      def self.resume(task, columns, count, &control)
+        commit_reports = yield(task, columns, count)
+
+        next_config_diff = {}
+        return next_config_diff
+      end
+
+      def self.guess(config)
+        # TODO: api_version should be 2 (the latest version)
+        # auth_type should be specified from config. (The future task)
+
+        username = config.param("username", :string)
+        password = config.param("password", :string)
+        uri = config.param("uri", :string)
+        api_version = "latest"
+        auth_type = "basic"
+        jql = config.param("jql", :string)
+
+        jira = Jira::Api.setup do |jira_config|
+          jira_config.username = username
+          jira_config.password = password
+          jira_config.uri = uri
+          jira_config.api_version = api_version
+          jira_config.auth_type = auth_type
+        end
+
+        # TODO: we use 0..10 issues to guess config?
+        records = jira.search_issues(jql)[0..10].map do |issue|
+          issue.to_record
+        end
+
+        columns = JiraInputPluginUtils.guess_columns(records)
+
+        guessed_config = {
+          "username" => username,
+          "password" => password,
+          "uri" => uri,
+          "api_version" => api_version,
+          "auth_type" => auth_type,
+          "columns" => columns,
+        }
+
+        return guessed_config
+      end
+
+      def init
+        @attributes = task["attributes"]
+        @jira = Jira::Api.setup do |config|
+          config.username = task["username"]
+          config.password = task["password"]
+          config.uri = task["uri"]
+          config.api_version = "latest"
+          config.auth_type = :basic
+        end
+        @jql = task["jql"]
+      end
+
+      def run
+        total_count = @jira.total_count(@jql)
+
+        0.step(total_count, PER_PAGE) do |start_at|
+          @jira.search_issues(@jql, start_at: start_at).each do |issue|
+            values = @attributes.map do |(attribute_name, type)|
+              JiraInputPluginUtils.cast(issue[attribute_name], type)
+            end
+
+            page_builder.add(values)
+          end
+        end
+
+        page_builder.finish
+
+        commit_report = {}
+        return commit_report
+      end
+    end
+  end
+end

data/lib/jira/api.rb

@@ -0,0 +1,25 @@
+require "jiralicious"
+require "jira/issue"
+
+module Jira
+  class Api
+    def self.setup(&block)
+      Jiralicious.configure(&block)
+      new
+    end
+
+    def search_issues(jql, options={})
+      search(jql, options).issues.map do |issue|
+        ::Jira::Issue.new(issue)
+      end
+    end
+
+    def search(jql, options={})
+      Jiralicious.search(jql, options)
+    end
+
+    def total_count(jql)
+      search(jql, max_results: 1).num_results
+    end
+  end
+end

data/lib/jira/issue.rb

@@ -0,0 +1,63 @@
+module Jira
+  class Issue
+    attr_reader :id, :key, :fields
+
+    def initialize(attributes)
+      @id = attributes.fetch("id")
+
+      # https://github.com/dorack/jiralicious/blob/404b7b6d5b7020f42064cf8d7a745ab02057e728/lib/jiralicious/issue.rb#L11-L12
+      @key = attributes.fetch("jira_key")
+      @fields = attributes.fetch("fields")
+    end
+
+    def [](attribute)
+      case attribute
+      when "id"
+        return id
+      when "key"
+        return key
+      end
+
+      chunk = fields
+      attribute.split('.').each do |key|
+        chunk = chunk[key]
+        return chunk if chunk.nil?
+      end
+
+      if chunk.is_a?(Array) || chunk.is_a?(Hash)
+        chunk.to_json.to_s
+      else
+        chunk
+      end
+    end
+
+    def to_record
+      record = {}
+
+      record["id"] = id
+      record["key"] = key
+
+      fields.each_pair do |key, value|
+        record_key = key
+        record_value = value.to_json.to_s
+
+        case value
+        when String
+          record_value = value
+        when Hash
+          if value.keys.include?("name")
+            record_key += ".name"
+            record_value = value["name"]
+          elsif value.keys.include?("id")
+            record_key += ".id"
+            record_value = value["id"]
+          end
+        end
+
+        record[record_key] = record_value
+      end
+
+      record
+    end
+  end
+end

data/spec/embulk/input/jira-input-plugin-utils_spec.rb

@@ -0,0 +1,88 @@
+require "spec_helper"
+require "embulk/input/jira-input-plugin-utils"
+
+describe Embulk::Input::JiraInputPluginUtils do
+  describe ".guess_columns" do
+    subject do
+      Embulk::Input::JiraInputPluginUtils.guess_columns(records)
+    end
+
+    let(:records) do
+      [
+        {"project_key" => "FOO", "comment.total" => 3, "created" => "2015-03-01T00:12:00"}
+      ]
+    end
+
+    let(:expected) do
+      [
+        {name: "project_key", type: :string},
+        {name: "comment.total", type: :long},
+        {name: "created", type: :timestamp, format: "%Y-%m-%dT%H:%M:%S"}
+      ]
+    end
+
+    it "returns Array containing columns without 'index' key from each record" do
+      expect(subject).to eq expected
+    end
+  end
+
+  describe ".cast" do
+    subject do
+      Embulk::Input::JiraInputPluginUtils.cast(value, type)
+    end
+
+    context "when value is nil" do
+      let(:value) { nil }
+      let(:type) { :string }
+
+      it "returns nil" do
+        expect(subject).to be_nil
+      end
+    end
+
+    context "when value is not nil" do
+      let(:value) { 123 }
+
+      context "and type is :string" do
+        let(:type) { :string }
+
+        it "returns '123'" do
+          expect(subject).to eq "123"
+        end
+      end
+
+      context "and type is :long" do
+        let(:type) { :long }
+
+        it "returns 123" do
+          expect(subject).to eq 123
+        end
+      end
+
+      context "and type is :double" do
+        let(:type) { :double }
+
+        it "returns 123.0" do
+          expect(subject).to eq 123.0
+        end
+      end
+
+      context "and type is :timestamp" do
+        let(:value) { "2015-03-01T00:12:00" }
+        let(:type) { :timestamp }
+
+        it "returns Time object" do
+          expect(subject).to eq Time.new(2015, 3, 1, 0, 12, 0)
+        end
+      end
+
+      context "and type is :boolean" do
+        let(:type) { :boolean }
+
+        it "returns true" do
+          expect(subject).to be true
+        end
+      end
+    end
+  end
+end

data/spec/embulk/input/jira_spec.rb

@@ -0,0 +1,247 @@
+require "spec_helper"
+require "embulk/input/jira"
+
+describe Embulk::Input::JiraInputPlugin do
+  let(:username) { "jira-user" }
+  let(:password) { "password" }
+  let(:uri) { "http://jira.example/" }
+  let(:jql) { "PROJECT=#{project_name}" }
+  let(:project_name) { "FOO" }
+
+  describe ".transaction" do
+    subject { Embulk::Input::JiraInputPlugin.transaction(config, &control) }
+
+    let(:config) { Object.new } # add mock later
+    let(:control) { Proc.new{|task, columns, count| } } # do nothing
+
+    let(:task) do
+      {
+        "username" => username,
+        "password" => password,
+        "uri" => uri,
+        "jql" => jql,
+        "attributes" => {
+          "project.key" => :string,
+          "comment.total" => :long
+        }
+      }
+    end
+
+    let(:columns) do
+      [
+        {"name" => "project.key", "type" => "string"},
+        {"name" => "comment.total", "type" => "long"}
+      ]
+    end
+
+    let(:column_structs) do
+      [
+        Embulk::Column.new(nil, "project.key", :string),
+        Embulk::Column.new(nil, "comment.total", :long)
+      ]
+    end
+
+    before do
+      allow(config).to receive(:param).with("username", :string).and_return(username)
+      allow(config).to receive(:param).with("password", :string).and_return(password)
+      allow(config).to receive(:param).with("uri", :string).and_return(uri)
+      allow(config).to receive(:param).with("jql", :string).and_return(jql)
+      allow(config).to receive(:param).with("columns", :array).and_return(columns)
+    end
+
+    # NOTE: I should check other factor, but i don't know it...
+    it "calls .resume method with proper parameters" do
+      expect(Embulk::Input::JiraInputPlugin).to receive(:resume).with(task, column_structs, 1, &control)
+      subject
+    end
+  end
+
+  describe ".resume" do
+    subject { Embulk::Input::JiraInputPlugin.resume(task, columns, count, &control) }
+
+    let(:task) do
+      {
+        "username" => username,
+        "password" => password,
+        "uri" => uri,
+        "jql" => jql,
+        "attributes" => {
+          "project.key" => :string,
+          "comment.total" => :long
+        }
+      }
+    end
+
+    let(:columns) do
+      [
+        Embulk::Column.new(nil, "project.key", :string),
+        Embulk::Column.new(nil, "comment.total", :long)
+      ]
+    end
+
+    let(:count) { 1 }
+    let(:control) { Proc.new{|task, columns, count| } } # do nothing
+
+    let(:next_config_diff) { {} }
+
+    it "returns next_config_diff" do
+      expect(subject).to eq next_config_diff
+    end
+  end
+
+  describe ".guess" do
+    subject { Embulk::Input::JiraInputPlugin.guess(config) }
+
+    let(:config) { Object.new } # add mock later
+
+    let(:jira_api) { Jira::Api.new }
+    let(:jira_issues) { [Jira::Issue.new(attributes)] }
+    let(:attributes) do
+      {
+        "id" => "100",
+        "jira_key" => "FOO-100",
+        "fields" =>
+        {
+          "project" => {
+            "name" => project_name,
+            "key" => project_name,
+          },
+          "comment" => {
+            "total" => 0,
+            "comments" => []
+          }
+        }
+      }
+    end
+
+    let(:guessed_config) do
+      {
+        "username" => username,
+        "password" => password,
+        "uri" => uri,
+        "api_version" => "latest",
+        "auth_type" => "basic",
+        "columns" => [
+          {name: "id", type: :long},
+          {name: "key", type: :string},
+          {name: "project.name", type: :string},
+          {name: "comment", type: :string}
+        ]
+      }
+    end
+
+    before do
+      allow(jira_api).to receive(:search_issues).and_return(jira_issues)
+
+      allow(config).to receive(:param).with("username", :string).and_return(username)
+      allow(config).to receive(:param).with("password", :string).and_return(password)
+      allow(config).to receive(:param).with("uri", :string).and_return(uri)
+      allow(config).to receive(:param).with("jql", :string).and_return(jql)
+    end
+
+    it "setup Jira::Api" do
+      expect(Jira::Api).to receive(:setup).and_return(jira_api)
+      subject
+    end
+
+    it "returns guessed config" do
+      allow(Jira::Api).to receive(:setup).and_return(jira_api)
+
+      expect(subject).to eq guessed_config
+    end
+  end
+
+  describe "#init (.new)" do
+    # NOTE: InputPlugin.initialize calls #init method.
+
+    subject { Embulk::Input::JiraInputPlugin.new({}, nil, nil, nil) }
+
+    it "setup Jira::Api" do
+      expect(Jira::Api).to receive(:setup)
+      subject
+    end
+
+    it "is a Embulk::InputPlugin" do
+      allow(Jira::Api).to receive(:setup)
+      expect(subject).to be_a(Embulk::InputPlugin)
+    end
+  end
+
+  describe "#run" do
+    subject do
+      Embulk::Input::JiraInputPlugin.new(task, nil, nil, page_builder).run
+    end
+
+    let(:jira_api) { Jira::Api.new }
+    let(:jira_issues) do
+      (1..total_count).map do |i|
+        attributes = fields.merge("id" => i.to_s, "jira_key" => "FOO-#{i}")
+
+        Jira::Issue.new(attributes)
+      end
+    end
+
+    let(:total_count) { max_result + 10 }
+    let(:max_result) { Embulk::Input::JiraInputPlugin::PER_PAGE }
+
+
+    let(:page_builder) { Object.new } # add mock later
+    let(:task) do
+      {
+        "jql" => jql,
+        "attributes" => {"project.key" => "string"}
+      }
+    end
+
+    let(:fields) do
+      {
+        "fields" =>
+        {
+          "project" => {
+            "key" => project_name,
+          },
+        }
+      }
+    end
+
+    let(:commit_report) { {} }
+
+    before do
+      # TODO: create stubs without each `it` expected
+      allow(Jira::Api).to receive(:setup).and_return(jira_api)
+
+      0.step(total_count, max_result) do |start_at|
+        issues = jira_issues[start_at..(start_at + max_result - 1)]
+        allow(jira_api).to receive(:search_issues).with(jql, start_at: start_at).and_return(issues)
+      end
+      allow(jira_api).to receive(:total_count).and_return(total_count)
+
+      allow(page_builder).to receive(:add).with([project_name])
+      allow(page_builder).to receive(:finish)
+    end
+
+    it 'search JIRA issues' do
+      expect(jira_api).to receive(:search_issues)
+      subject
+    end
+
+    it 'page build and finish' do
+      expect(page_builder).to receive(:add).with([project_name]).exactly(total_count).times
+      expect(page_builder).to receive(:finish)
+      subject
+    end
+
+    it 'returns commit report' do
+      expect(subject).to eq commit_report
+    end
+  end
+
+  describe ".version" do
+    let(:version_file_path) { File.expand_path("../../../../VERSION", __FILE__) }
+    subject { Embulk::Input::JiraInputPlugin.version }
+
+    it "returns VERSION file content without line-break" do
+      expect(subject).to eq File.read(version_file_path).strip
+    end
+  end
+end

data/spec/embulk_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Embulk do
+  describe "registerd jira as input plugin" do
+    let(:config) { <<-YAML }
+in:
+  type: jira
+    YAML
+    let(:config_file) { Tempfile.new("embulk-conf") }
+
+    before do
+      config_file.puts config
+      config_file.close
+    end
+
+    subject {
+      capture_output(:out) do
+        Embulk.run ["preview", config_file.path]
+      end
+    }
+
+    it do
+      # NOTE: can't stub `exit` so stubbing `raise`
+      # https://github.com/embulk/embulk/blob/v0.6.9/lib/embulk/command/embulk_run.rb#L335
+      allow(Embulk).to receive(:raise)
+
+      is_expected.to_not include("InputPlugin 'jira' is not found.")
+    end
+  end
+end

data/spec/jira/issue_spec.rb

@@ -0,0 +1,181 @@
+require "spec_helper"
+require "jira/issue"
+
+describe Jira::Issue do
+  describe ".initialize" do
+    context "when argument has 'fields' key" do
+      let(:issue_attributes) do
+        {
+          "id" => 1,
+          "jira_key" => "PRO-1",
+          "fields" =>
+          {
+            "summary" => "jira issue",
+            "project" =>
+            {
+              "key" => "FOO",
+            },
+          }
+        }
+      end
+
+      it "has @id with argument['id']" do
+        expect(Jira::Issue.new(issue_attributes).id).to eq issue_attributes["id"]
+      end
+
+      it "has @key with argument['jira_key']" do
+        expect(Jira::Issue.new(issue_attributes).key).to eq issue_attributes["jira_key"]
+      end
+
+      it "has @fields with argument['fields']" do
+        expect(Jira::Issue.new(issue_attributes).fields).to eq issue_attributes["fields"]
+      end
+    end
+
+    context "when argument doesn't have 'fields' key" do
+      let(:issue_attributes) do
+        {}
+      end
+
+      it "raises error" do
+        expect { Jira::Issue.new(issue_attributes) }.to raise_error
+      end
+    end
+  end
+
+  describe "#[]" do
+    subject { Jira::Issue.new(issue_attributes)[attribute_name] }
+
+    let(:issue_attributes) do
+      {
+        "id" => "1",
+        "jira_key" => "FOO-1",
+        "fields" => {
+          "summary" => "jira issue",
+          "project" => project_attribute,
+          "labels" =>
+          [
+            "Feature",
+            "WantTo"
+          ],
+          "priority" => {
+            "iconUrl" => "https://jira-api/images/icon.png",
+            "name" => "Must",
+            "id" => "1"
+          },
+          "customfield_1" => nil,
+        }
+      }
+    end
+
+    let(:project_attribute) do
+      {
+        "key" => "FOO",
+      }
+    end
+
+    context 'id' do
+      let(:attribute_name) { 'id' }
+
+      it "returns issue id" do
+        expect(subject).to eq "1"
+      end
+    end
+
+    context 'key' do
+      let(:attribute_name) { 'key' }
+
+      it "returns issue key" do
+        expect(subject).to eq "FOO-1"
+      end
+    end
+
+    context 'summary' do
+      let(:attribute_name) { 'summary' }
+
+      it "returns issue summary" do
+        expect(subject).to eq 'jira issue'
+      end
+    end
+
+    context 'project.key' do
+      let(:attribute_name) { 'project.key' }
+
+      context "when project is not nil" do
+        it "returns issue's project key" do
+          expect(subject).to eq 'FOO'
+        end
+      end
+
+      context "when project is nil" do
+        let(:project_attribute) { nil }
+
+        it "returns nil" do
+          expect(subject).to be_nil
+        end
+      end
+    end
+
+    context 'labels' do
+      let(:attribute_name) { 'labels' }
+
+      it "returns issue's labels JSON string" do
+        expect(subject).to eq '["Feature","WantTo"]'
+      end
+    end
+
+    context 'priority' do
+      let(:attribute_name) { 'priority' }
+
+      it "returns issue's priority JSON string" do
+        expect(subject).to eq '{"iconUrl":"https://jira-api/images/icon.png","name":"Must","id":"1"}'
+      end
+    end
+  end
+
+  describe "#to_record" do
+    subject do
+      Jira::Issue.new(issue_attributes).to_record
+    end
+
+    let(:issue_attributes) do
+      {
+        "id" => 1,
+        "jira_key" => "FOO-1",
+        "fields" => {
+          "summary" => "jira issue",
+          "project" => {
+            "id" => "FOO",
+          },
+          "labels" =>
+          [
+            "Feature",
+            "WantTo"
+          ],
+          "priority" => {
+            "iconUrl" => "https://jira-api/images/icon.png",
+            "name" => "Must",
+            "id" => "1"
+          },
+          "customfield_1" => nil,
+        }
+      }
+    end
+
+    let(:expected) do
+      {
+        "id" => 1,
+        "key" => "FOO-1",
+        "summary" => "jira issue",
+        "project.id" => "FOO",
+        "labels" => "[\"Feature\",\"WantTo\"]",
+        "priority.name" => "Must",
+        "customfield_1" => "null"
+      }
+    end
+
+    it 'return guessed record' do
+      expect(subject).to eq expected
+    end
+  end
+end

data/spec/jira_api_spec.rb

@@ -0,0 +1,92 @@
+# TODO: move to spec/jira/api_spec.rb
+
+require "spec_helper"
+require "jira/api"
+
+describe Jira::Api do
+  describe ".setup" do
+    subject { Jira::Api.setup {}  }
+
+    it "returns Jira::Api instance" do
+      expect(subject.is_a?(Jira::Api)).to be_truthy
+    end
+
+    it "calls Jiralicious.configure" do
+      allow(Jiralicious).to receive(:configure)
+    end
+  end
+
+  describe "#search" do
+    let(:jql) { "project=FOO" }
+
+    subject { Jira::Api.new.search(jql) }
+
+    it do
+      allow(Jiralicious).to receive(:search).with(jql)
+    end
+  end
+
+  describe "#search_issues" do
+    let(:jql) { "project=FOO" }
+    let(:results) do
+      [
+        {
+          "id" => 1,
+          "jira_key" => "FOO-1",
+          "fields" =>
+          {
+            "summary" => "issue summary",
+            "project" =>
+            {
+              "key" => "FOO"
+            }
+          }
+        },
+        {
+          "id" => 2,
+          "jira_key" => "FOO-2",
+          "fields" =>
+          {
+            "summary" => "jira issue",
+            "project" =>
+            {
+              "key" => "FOO"
+            }
+          }
+        }
+      ]
+    end
+
+    subject { Jira::Api.new.search_issues(jql) }
+
+    it do
+      allow(Jiralicious).to receive_message_chain(:search, :issues).and_return(results)
+
+      expect(subject).to be_kind_of Array
+      expect(subject.map(&:class)).to match_array [Jira::Issue, Jira::Issue]
+    end
+  end
+
+  describe "#total_count" do
+    subject { jira_api.total_count(jql) }
+
+    let(:jira_api) { Jira::Api.new }
+    let(:jql) { "project=FOO" }
+    let(:results) { Object.new } # add mock later
+    let(:results_count) { 5 }
+
+    before do
+      allow(results).to receive(:num_results).and_return(results_count)
+    end
+
+    it "calls Jira::Api#search with proper arguments" do
+      expect(jira_api).to receive(:search).with(jql, max_results: 1).and_return(results)
+      subject
+    end
+
+    it "returns issues count" do
+      allow(jira_api).to receive(:search).with(jql, max_results: 1).and_return(results)
+      expect(subject).to eq results_count
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "bundler/setup"
+Bundler.require(:runtime, :development)
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "embulk/command/embulk_run"
+
+Dir["./spec/support/**/*.rb"].each{|file| require file }
+
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.start
+end
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+RSpec.configure do |config|
+  config.include StdoutAndErrCapture
+  config.include PrepareEmbulk
+end

data/spec/support/prepare_embulk.rb

@@ -0,0 +1,12 @@
+module PrepareEmbulk
+  require "embulk/command/embulk_run"
+
+  classpath_dir = Embulk.home("classpath")
+  jars = Dir.entries(classpath_dir).select{|f| f =~ /\.jar$/ }.sort
+  jars.each do |jar|
+    require File.join(classpath_dir, jar)
+  end
+  require "embulk/java/bootstrap"
+
+  require "embulk"
+end

data/spec/support/stdout_and_err_capture.rb

@@ -0,0 +1,32 @@
+module StdoutAndErrCapture
+  def capture_output(output = :out, &block)
+    java_import 'java.io.PrintStream'
+    java_import 'java.io.ByteArrayOutputStream'
+    java_import 'java.lang.System'
+
+    ruby_original_stream = output == :out ? $stdout.dup : $stderr.dup
+    java_original_stream = System.send(output) # :out or :err
+    ruby_buf = StringIO.new
+    java_buf = ByteArrayOutputStream.new
+
+    case output
+    when :out
+      $stdout = ruby_buf
+    when :err
+      $stderr = ruby_buf
+    end
+    System.setOut(PrintStream.new(java_buf))
+
+    block.call
+
+    ruby_buf.string + java_buf.toString
+  ensure
+    System.setOut(java_original_stream)
+    case output
+    when :out
+      $stdout = ruby_original_stream
+    when :err
+      $stderr = ruby_original_stream
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: embulk-input-jira
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- uu59
+- yoshihara
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  name: jiralicious
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: simplecov
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: pry
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Loads records from Jira.
+email:
+- k@uu59.org
+- h.yoshihara@everyleaf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- embulk-input-jira.gemspec
+- lib/embulk/input/jira-input-plugin-utils.rb
+- lib/embulk/input/jira.rb
+- lib/jira/api.rb
+- lib/jira/issue.rb
+- spec/embulk/input/jira-input-plugin-utils_spec.rb
+- spec/embulk/input/jira_spec.rb
+- spec/embulk_spec.rb
+- spec/jira/issue_spec.rb
+- spec/jira_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/prepare_embulk.rb
+- spec/support/stdout_and_err_capture.rb
+homepage: https://github.com/treasure-data/embulk-input-jira
+licenses:
+- Apache2
+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: Jira input plugin for Embulk
+test_files:
+- spec/embulk/input/jira-input-plugin-utils_spec.rb
+- spec/embulk/input/jira_spec.rb
+- spec/embulk_spec.rb
+- spec/jira/issue_spec.rb
+- spec/jira_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/prepare_embulk.rb
+- spec/support/stdout_and_err_capture.rb