ki_youtrack 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ben Brinckerhoff
+
+MIT License
+
+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,2 @@
+ki_youtrack
+===========

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new("spec:coverage") do |t|
+  ENV['COVERAGE'] = "true"
+end
+
+desc "Delete *all* VCR cassettes (!)"
+namespace :spec do
+  task :vcr_wipe do
+    FileUtils.rm_rf('spec/fixtures/vcr_cassettes')
+  end
+end

data/bin/ki_youtrack

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# 1.9 adds realpath to resolve symlinks; 1.8 doesn't
+# have this method, so we add it so we get resolved symlinks
+# and compatibility
+unless File.respond_to? :realpath
+  class File #:nodoc:
+    def self.realpath path
+      return realpath(File.readlink(path)) if symlink?(path)
+      path
+    end
+  end
+end
+
+$LOAD_PATH << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'rubygems'
+require 'gli'
+require 'ki_youtrack'
+
+include GLI
+
+program_desc 'A command-line interface to YouTrack'
+
+version KiYoutrack::VERSION
+
+# pre do |global_options,command,options,args|
+# end
+
+desc 'Get a issue'
+arg_name '[issue id]'
+command :issue do |c|
+  c.action do |global_options, options, args|
+    pretty = $stdout.tty?
+
+    id = args.first
+    json = KiYoutrack::Api.issue(id, :pretty => pretty)
+    $stdout.puts(json)
+  end
+end
+
+desc 'Set up config file'
+command :setup do |c|
+  c.action do |global_options, options, args|
+    config = Kiseru::Config[:ki_youtrack]
+
+    ui = HighLine.new
+
+    username = config.read(:username) || ui.ask("Username: ")
+    password = config.read(:password) || ui.ask("Password: ") { |q| q.echo = false }
+    subdomain = config.read(:subdomain) || ui.ask("Subdomain: ")
+
+    config.write(:username, username)
+    config.write(:password, password)
+    config.write(:subdomain, subdomain)
+  end
+end
+
+exit GLI.run(ARGV)

data/ki_youtrack.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ki_youtrack/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Ben Brinckerhoff", "Aaron Cronin"]
+  gem.email         = ["ben@freeagent.com", "aaron@freeagent.com"]
+  gem.description   = %q{Kiseru YouTrack client}
+  gem.summary       = %q{Kiseru YouTrack client}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "ki_youtrack"
+  gem.require_paths = ["lib"]
+  gem.version       = KiYoutrack::VERSION
+
+  gem.add_dependency('gli')
+  gem.add_dependency('faraday')
+  gem.add_dependency('faraday_middleware')
+  gem.add_dependency('multi_xml')
+  gem.add_dependency('multi_json')
+  gem.add_dependency('highline')
+
+  gem.add_development_dependency('debugger')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('simplecov')
+  gem.add_development_dependency('test-construct')
+  gem.add_development_dependency('vcr')
+  gem.add_development_dependency('webmock')
+end

data/lib/ki_youtrack/api.rb

@@ -0,0 +1,21 @@
+module KiYoutrack
+
+  class Api
+
+    def self.issue(id, opts = {})
+      config = Kiseru::Config[:ki_youtrack]
+      username = config.read(:username)
+      password = config.read(:password)
+      subdomain = config.read(:subdomain)
+      ssl = config.read(:ssl)
+      session = Session.new(username, password, subdomain, :ssl => ssl)
+      session.init
+      response = session.get_bug(id)
+
+      filtered_data = IssueFilter.filter(response.body['issue'])
+      MultiJson.dump(filtered_data, :pretty => opts[:pretty])
+    end
+
+  end
+
+end

data/lib/ki_youtrack/creds.rb

@@ -0,0 +1,10 @@
+module KiYoutrack
+
+  class Creds
+
+    def self.get
+    end
+
+  end
+
+end

data/lib/ki_youtrack/issue_filter.rb

@@ -0,0 +1,25 @@
+module KiYoutrack
+
+  class IssueFilter
+
+    def self.filter(data)
+      new_data = {}
+      new_data['id']= data['id']
+
+      data['field'].each do |field|
+        new_data[field['name']] = field['value']
+      end
+      # TODO - this should not know about the config here!
+      # If filter needs data, it should be passed in!
+      config = Kiseru::Config[:ki_youtrack]
+      subdomain = config.read(:subdomain)
+      ssl = config.read(:ssl)
+      new_data['issue_url'] = Session.url(subdomain, ssl) + '/youtrack/issues/' + data['id']
+      new_data['ki_type'] = 'youtrack_issue'
+
+      new_data
+    end
+
+  end
+
+end

data/lib/ki_youtrack/kiseru.rb

@@ -0,0 +1,48 @@
+module Kiseru
+
+  class ConfigDir
+
+    DIR_NAME = '.kiseru'
+
+    attr_reader :path
+
+    def initialize(opts = {})
+      root = Pathname.new(File.expand_path(opts.fetch(:root) { '~' }))
+      @path = root + DIR_NAME
+      unless File.directory?(@path)
+        Dir.mkdir(@path)
+      end
+    end
+
+    def config(app_name)
+      Config.new(@path, app_name)
+    end
+
+  end
+
+  class Config
+
+    def self.[](key)
+      ConfigDir.new.config(key)
+    end
+
+    def initialize(root_path, app_name)
+      file_path = (root_path + "#{app_name}.yml").to_s
+      @store = YAML::Store.new(file_path)
+    end
+
+    def write(key, time)
+      @store.transaction do
+        @store[key] = time
+      end
+    end
+
+    def read(key)
+      @store.transaction(read_only=true) do
+        @store[key]
+      end
+    end
+
+  end
+
+end

data/lib/ki_youtrack/session.rb

@@ -0,0 +1,52 @@
+module KiYoutrack
+
+  class Session
+
+    attr_reader :session_cookies, :api_url
+
+    # TODO - hacky, remove this
+    # TODO - the default for SSL should be in ONE place
+    def self.url(subdomain, ssl)
+      ssl = true if ssl.nil?
+      protocol = ssl ? "https" : "http"
+      "#{protocol}://#{subdomain}.myjetbrains.com"
+    end
+
+    def initialize(username, password, subdomain, opts = {})
+      ssl = opts.fetch(:ssl, true)
+      @username = username
+      @password = password
+      @api_url = Session.url(subdomain, ssl)
+    end
+
+    def init
+      response = connection.post("/youtrack/rest/user/login",
+                      :login => @username,
+                      :password => @password)
+      @session_cookies = response.headers['set-cookie']
+      response
+    end
+
+    def get_bug(id)
+      connection.get do |req|
+        req.url "/youtrack/rest/issue/#{id}"
+        req.headers['Cookie'] = session_cookies
+      end
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(:url => @api_url) do |faraday|
+        faraday.request  :url_encoded             # form-encode POST params
+        if ENV['DEBUG']=='true'
+          faraday.response :logger                  # log requests to STDOUT
+        end
+        faraday.response :xml, :content_type => /\bxml$/
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+  end
+
+end

data/lib/ki_youtrack/version.rb

@@ -0,0 +1,3 @@
+module KiYoutrack
+  VERSION = "0.0.1"
+end

data/lib/ki_youtrack.rb

@@ -0,0 +1,20 @@
+require "ki_youtrack/version"
+require 'faraday'
+require 'faraday_middleware'
+require 'multi_xml'
+require 'multi_json'
+require 'yaml/store'
+require 'highline'
+
+autoload :Kiseru, 'ki_youtrack/kiseru'
+
+module KiYoutrack
+
+  autoload :Api, 'ki_youtrack/api'
+  autoload :Creds, 'ki_youtrack/creds'
+  autoload :Session, 'ki_youtrack/session'
+  autoload :IssueFilter, 'ki_youtrack/issue_filter'
+
+end
+
+KiYouTrack = KiYoutrack

data/spec/integration/get_bug_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+include KiYoutrack
+
+describe KiYoutrack::Api do
+
+  it "gets JSON for issue", :vcr do
+    json = Api.issue("KI-1")
+    data = MultiJson.load(json)
+    data['id'].should == 'KI-1'
+    data['ki_type'].should == 'youtrack_issue'
+  end
+
+  it "pretty prints JSON if requested", :vcr do
+    json = Api.issue("KI-1", :pretty => false)
+
+    pretty_json = MultiJson.dump(MultiJson.load(json), :pretty => true)
+    normal_json = MultiJson.dump(MultiJson.load(json), :pretty => false)
+
+    json.should == normal_json
+    Api.issue("KI-1", :pretty => true).should == pretty_json
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'ki_youtrack'
+require 'vcr'
+require 'pp'
+require 'construct'
+
+include Construct::Helpers
+include KiYoutrack
+
+if [0, 'false', false, 'f', 'n', 'no', 'off'].include?(ENV['VCR'])
+  puts "VCR off"
+else
+  puts "VCR on!"
+  VCR.configure do |c|
+    c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+    c.hook_into :webmock
+    c.allow_http_connections_when_no_cassette = true
+    c.configure_rspec_metadata!
+  end
+end
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/issue_filter_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe IssueFilter do
+
+  let(:data) do
+    {"field"=>
+      [{"value"=>"Project X", "type"=>"SingleField", "name"=>"projectShortName"},
+       {"value"=>"123", "type"=>"SingleField", "name"=>"numberInProject"},
+       {"value"=>"A SUMMARY",
+         "type"=>"SingleField",
+         "name"=>"summary"},
+       {"value"=>
+         "A DESCRIPTION",
+         "type"=>"SingleField",
+         "name"=>"description"},
+       {"value"=>"1342536743244", "type"=>"SingleField", "name"=>"created"},
+       {"value"=>"1342536761703", "type"=>"SingleField", "name"=>"updated"},
+       {"value"=>"Bob", "type"=>"SingleField", "name"=>"updaterName"},
+       {"value"=>"bob@foobar.com",
+         "type"=>"SingleField",
+         "name"=>"updaterFullName"},
+       {"value"=>"Jane", "type"=>"SingleField", "name"=>"reporterName"},
+       {"value"=>"jane@foobar.com",
+         "type"=>"SingleField",
+         "name"=>"reporterFullName"},
+       {"value"=>"Bug", "type"=>"CustomField", "name"=>"Type"},
+       {"value"=>"99", "type"=>"CustomField", "name"=>"Bug Score"}
+      ],
+      "id"=>"FA-123"
+    }
+  end
+
+  def deep_clone(obj)
+    Marshal.load(Marshal.dump(obj))
+  end
+
+  it "doesn't modify data" do
+    old_data = deep_clone(data)
+    IssueFilter.filter(data)
+    old_data.should == data
+  end
+
+  it "adds ki_type" do
+    new_data = IssueFilter.filter(data)
+    new_data['ki_type'].should == "youtrack_issue"
+  end
+
+  it "includes id" do
+    new_data = IssueFilter.filter(data)
+    new_data['id'].should == "FA-123"
+  end
+
+  it "includes summary" do
+    new_data = IssueFilter.filter(data)
+    new_data['summary'].should == "A SUMMARY"
+  end
+
+  it "includes description" do
+    new_data = IssueFilter.filter(data)
+    new_data['description'].should == "A DESCRIPTION"
+  end
+
+  it "includes custom field" do
+    new_data = IssueFilter.filter(data)
+    new_data['Type'].should == "Bug"
+  end
+
+end

data/spec/unit/kiseru_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Kiseru::ConfigDir do
+
+  context "when directory does not exist" do
+
+    it "should create directory" do
+      within_construct(false) do |c|
+        Kiseru::ConfigDir.new(:root => c)
+        File.directory?(c+'.kiseru').should be_true
+      end
+    end
+
+  end
+
+  it "creates ki_pivotal.yml and writes API token" do
+    within_construct(false) do |c|
+      d = c.directory '.kiseru'
+      config_dir = Kiseru::ConfigDir.new(:root => c)
+      config = config_dir.config(:ki_pivotal)
+
+      config.write(:api_token, 'fake_token')
+
+      config.read(:api_token).should == 'fake_token'
+    end
+  end
+
+end

data/spec/unit/session_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+include KiYoutrack
+
+describe KiYoutrack::Session do
+  before do
+    # These tests will fail until you create a valid config file
+    # by doing 'ki_youtrack setup'
+    config = Kiseru::Config[:ki_youtrack]
+    @username = config.read(:username)
+    @password = config.read(:password)
+    @subdomain = config.read(:subdomain)
+  end
+
+  it "fails if credentials are not valid", :vcr do
+    # Until a dedicated YouTrack is created for this project
+    # a valid subdomain must be supplied otherwise the HTTP
+    # status code will be 404 instead of 403
+    session = Session.new("foo", "bar", @subdomain, :ssl => false)
+    response = session.init
+    response.status.should == 403
+    response.body['error'].should match /Incorrect login or password/
+  end
+
+  it "responds 200 and gets headers if creds are valid", :vcr do
+    session = Session.new(@username, @password, @subdomain, :ssl => false)
+    response = session.init
+    response.status.should == 200
+    response.headers["set-cookie"].should_not be_nil
+    session.session_cookies.should == response.headers["set-cookie"]
+  end
+
+  it "uses authentication cookies to get bug", :vcr do
+    session = Session.new(@username, @password, @subdomain, :ssl => false)
+    session.init
+    response = session.get_bug("KI-1")
+    response.status.should == 200
+    response.body.should_not be_nil
+    issue = response.body['issue']
+    issue['id'].should == "KI-1"
+  end
+
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: ki_youtrack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ben Brinckerhoff
+- Aaron Cronin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-14 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: &70324410656340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70324410656340
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70324410655920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70324410655920
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70324410655500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70324410655500
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: &70324410655080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70324410655080
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70324410654660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70324410654660
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &70324410654240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70324410654240
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &70324410653820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70324410653820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70324410653400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70324410653400
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70324410652980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70324410652980
+- !ruby/object:Gem::Dependency
+  name: test-construct
+  requirement: &70324410652560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70324410652560
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70324410652140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70324410652140
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70324410651720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70324410651720
+description: Kiseru YouTrack client
+email:
+- ben@freeagent.com
+- aaron@freeagent.com
+executables:
+- ki_youtrack
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ki_youtrack
+- ki_youtrack.gemspec
+- lib/ki_youtrack.rb
+- lib/ki_youtrack/api.rb
+- lib/ki_youtrack/creds.rb
+- lib/ki_youtrack/issue_filter.rb
+- lib/ki_youtrack/kiseru.rb
+- lib/ki_youtrack/session.rb
+- lib/ki_youtrack/version.rb
+- spec/integration/get_bug_spec.rb
+- spec/spec_helper.rb
+- spec/unit/issue_filter_spec.rb
+- spec/unit/kiseru_spec.rb
+- spec/unit/session_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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.10
+signing_key: 
+specification_version: 3
+summary: Kiseru YouTrack client
+test_files:
+- spec/integration/get_bug_spec.rb
+- spec/spec_helper.rb
+- spec/unit/issue_filter_spec.rb
+- spec/unit/kiseru_spec.rb
+- spec/unit/session_spec.rb