youtrack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20fcd027f9f2ccbe21f3c3899ece54d81ffd667f
+  data.tar.gz: 418054623251575f8917b2a3c65ee9ec0001f0da
+SHA512:
+  metadata.gz: 04739f2ccd49272e0542e32c347e5958c5d9e50e79085867ed687d7e360f619626e21c3b187dbb1d1753f6dabea07bf59a186165e59d4db32da5e8d2db7e3d08
+  data.tar.gz: 6bdac860776d6d68ba44bddfe934122650b278d16217751b8acc120e4f2e69d2a19262df1d714a929a24c425e0a34099d4aa8a0c4077d27d02a2dbc5a6c471da

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+script:
+  - bundle exec rspec
+  - bundle exec cucumber
+
+branches:
+  only:
+    - master
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+notifications:
+  email:
+    - jwaterfaucett@gmail.com

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Faucett
+
+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,51 @@
+# Youtrack
+
+youTrack REST API Client
+
+[![Build Status](https://travis-ci.org/jwaterfaucett/youtrack.png)](https://travis-ci.org/jwaterfaucett/youtrack)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'youtrack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install youtrack
+
+## Usage
+
+```ruby
+
+client = Youtrack::Client.new do |c|
+  c.url = "https://example.com"
+  c.login = "root"
+  c.password = "root"
+end
+
+```
+
+## Issues
+
+Any issues or bugs should be well documented submit as many details as possible.
+The best issues have the following characteristics:
+
+1. Detail description with a title that conveys the problem well.
+2. Gists and/or failing tests that show under what conditions the problem occurs.
+3. Environment information, platform, gem version, etc.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write your feature in Cucumber.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Make sure your feature and (optional) Rspec test are green.
+6. Rebase from master.
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "cucumber/rake/task"
+require "rspec/core/rake_task"
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/features/client/new_client_session.feature

@@ -0,0 +1,12 @@
+Feature: New Client Session
+
+  In order to start a new session with the youTrack Server
+  As a Client
+  I should be able to connect to the remote host
+
+  Scenario: starting a new session
+    Given I create a new Client
+    When I set the Client url to point to the Server
+      And I enter the correct login credentials
+      And I connect
+    Then I should be connected to the Server

data/features/step_definitions/client/client_steps.rb

@@ -0,0 +1,25 @@
+
+Given /^I create a new Client$/ do
+  @client = Youtrack::Client.new
+end
+
+Given /^I enter the correct login credentials$/ do
+  step "I set the Client#login= to <#{YServer::Login}>"
+  step "I set the Client#password= to <#{YServer::Password}>"
+end
+
+Given /^I set the Client url to point to the Server$/ do
+  @client.url = YServer::URL
+end
+
+Given /^I connect$/ do
+  @client.login!
+end
+
+Given /^I set the Client#([a-zA-Z_=]+) to <([a-zA-Z0-9_-]+)>$/ do |method, value|
+   @client.__send__(method, value)
+end
+
+Then /^I should be connected to the Server$/ do
+  @client.response.parsed_response["login"].should eq("ok")
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+require "youtrack"
+require "webmock/cucumber"
+
+module YServer
+  URL = "https://youtrackserver.com"
+  Login = "root"
+  Password = "root"
+end
+
+

data/features/support/webmock.rb

@@ -0,0 +1,20 @@
+include WebMock::API
+
+def server_url_for(endpoint, options={})
+  base = "#{YServer::URL}/rest/#{endpoint}"
+  if options[:query]
+    base += "?#{options[:query]}"
+  end
+end
+
+
+# STUBS
+
+# login
+stub_request(:post, server_url_for("login", query: "login=#{YServer::Password}&password=#{YServer::Login}"))
+  .to_return(
+    body: "<login>ok</login>",
+    headers: {
+      "Server" => "Jetty(6.1.23)",
+      "Content-Type" => "application/xml;charset=UTF-8"
+  })

data/features/support/world.rb

@@ -0,0 +1 @@
+World(YServer)

data/lib/youtrack.rb

@@ -0,0 +1,6 @@
+require "httparty"
+
+module Youtrack
+  autoload :Client, "youtrack/client"
+  autoload :VERSION, "youtrack/version"
+end

data/lib/youtrack/client.rb

@@ -0,0 +1,36 @@
+module Youtrack
+  class Client
+    include HTTParty
+
+    # holds the youTrack Server url
+    # defaults to nil
+    attr_accessor :url
+
+    # stores the Server login credential
+    # defaults to nil
+    attr_accessor :login
+      
+    # stores the Server password credential
+    # defaulst to nil
+    attr_accessor :password
+
+    # stores the response object
+    attr_accessor :response
+
+    def initialize(options={})
+    end
+
+    def server_endpoint
+      @server_endpoint ||= File.join(url, "rest")
+    end
+
+    def credentials_hash
+      { login: login, password: password }
+    end
+
+    def login!
+      @response = self.class.post(server_endpoint + "/login", { query: credentials_hash })
+    end
+
+  end
+end

data/lib/youtrack/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# 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 "webmock/rspec"
+
+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/youtrack.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'youtrack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "youtrack"
+  spec.version       = Youtrack::VERSION
+  spec.authors       = ["John Faucett"]
+  spec.email         = ["jwaterfaucett@gmail.com"]
+  spec.description   = %q{JetBrains youTrack Rest API Client in Ruby}
+  spec.summary       = %q{A Ruby REST API Client for JetBrains youTrack software}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # HARD DEPENDENCY
+  spec.add_dependency "httparty", "~> 0.12.0"
+
+  # DEVELOPMENT
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "cucumber", "~> 1.3.10"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "webmock", "~> 1.17.1"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: youtrack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Faucett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+description: JetBrains youTrack Rest API Client in Ruby
+email:
+- jwaterfaucett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/client/new_client_session.feature
+- features/step_definitions/client/client_steps.rb
+- features/support/env.rb
+- features/support/webmock.rb
+- features/support/world.rb
+- lib/youtrack.rb
+- lib/youtrack/client.rb
+- lib/youtrack/version.rb
+- spec/spec_helper.rb
+- youtrack.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby REST API Client for JetBrains youTrack software
+test_files:
+- features/client/new_client_session.feature
+- features/step_definitions/client/client_steps.rb
+- features/support/env.rb
+- features/support/webmock.rb
+- features/support/world.rb
+- spec/spec_helper.rb