rutrack 0.0.11.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b0ed1e3d05a9ba00d50cb1e56adc509f805750b
+  data.tar.gz: 7b325149a69f6e48150accc076f90b388f4ca918
+SHA512:
+  metadata.gz: 3f5de0c8c780a5b202421e450ca8260b1f1881fa84b72b7fe411be33e6d15b705654fee80f25d5baf2809251863b6d9b6c3bcc3db6b0f349d52852a67cd1cc47
+  data.tar.gz: 6d478f473f77d029f2baee22a3234874d75ed8c7ed63e7f02f32282ab552d01ef800d2e5b6e2268fdd67efebd7e9af7fbcb239cce20528488f76c12b432a797e

data/.envrc

@@ -0,0 +1 @@
+export PATH=$PWD/binstubs:$PATH

data/.gitignore

@@ -0,0 +1,21 @@
+*.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
+vendor/
+
+.idea

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+youtrack

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

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,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 John Faucett
+
+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,79 @@
+# Youtrack
+
+youTrack REST API Client
+
+[![Build Status](https://travis-ci.org/jwaterfaucett/youtrack.png)](https://travis-ci.org/jwaterfaucett/youtrack)
+[![Gem Version](https://badge.fury.io/rb/youtrack.png)](http://badge.fury.io/rb/youtrack)
+
+
+## New in this release 
+
+###### *(v. v0.0.11.1 - 13/12/16)*
+
+Max issues option & Filter support
+
+- Pass  **max issues** &  **filter** in `get_issues_for` request
+
+Example:
+
+```ruby
+
+filter = "Username: -{No username}" # youtrack-style filter
+max = 5000 # max issues to grab
+client.projects.get_issues_for(project_name, max, filter)
+```
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'youtrack', :git => "git://github.com/jesusinyourtown1/youtrack.git", :branch => "dev-new"
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+
+client = Youtrack::Client.new do |c|
+  c.url = "https://example.com"
+  c.login = "root"
+  c.password = "root"
+
+  # Hook into the Net::HTTP set_debug_output method for debugging HTTP Request/Response Cycles
+  c.debug = true
+end
+
+# Now connect to the server
+# It sets the Cookies and returns the Connection response status code
+client.connect!
+
+```
+
+## Examples
+
+To get a feel for the API browse the [examples directory](https://github.com/jwaterfaucett/youtrack/tree/master/examples).
+
+## 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/support/env.rb

@@ -0,0 +1,3 @@
+require "youtrack"
+require "webmock"
+

data/features/support/hooks.rb

@@ -0,0 +1 @@
+

data/features/support/vcr.rb

@@ -0,0 +1,16 @@
+require "vcr"
+
+
+VCR.config do |c|
+
+  # tell vcr where to store recorded responses
+  c.cassette_library_dir = "fixtures/cassette_library"
+  
+  # use webmock for stubbing
+  c.hook_into :webmock
+
+  # allow local requests
+  c.ignore_localhost = true
+
+  c.default_cassette_options = { record: :none }
+end

data/lib/youtrack.rb

@@ -0,0 +1,11 @@
+require "httparty"
+
+module Youtrack
+  autoload :Client,   "youtrack/client"
+  autoload :VERSION,  "youtrack/version"
+  autoload :Base,     "youtrack/resources/base"
+  autoload :Issue,    "youtrack/resources/issue"
+  autoload :Project,  "youtrack/resources/project"
+  autoload :User,     "youtrack/resources/user"
+  autoload :Tag,      "youtrack/resources/tag"
+end

data/lib/youtrack/client.rb

@@ -0,0 +1,86 @@
+module Youtrack
+  class Client
+
+    # 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 :connection
+
+    # stores the auth_headers
+    attr_accessor :cookies
+
+    # stores the scope of all subsequent api calls
+    attr_accessor :admin
+
+    def admin?
+      true == @admin
+    end
+
+    # Sets debugging mode
+    attr_accessor :debug
+
+    def initialize(options={}, &block)
+      @cookies  = {}
+      @admin    = false
+      @debug    = false
+
+      yield(self) if block_given?
+    end
+
+    # the server endpoint
+    def endpoint
+      @endpoint = File.join(url, 'rest')
+    end
+
+    def credentials_hash
+      { login: login, password: password }
+    end
+
+
+    # Makes a login call and sets the Cookie headers
+    # 
+    # Returns the status code of the connection call
+    def connect!
+      @connection = HTTParty.post(File.join(url, "rest/user/login"), body: credentials_hash )
+      #@connection = HTTParty.post(File.join(url, "hub/auth/login"), body: credentials_hash )
+      @cookies['Cookie'] = @connection.headers['set-cookie']
+      @connection.code
+    end
+
+    def connected?
+      !!(connection && connection.headers['set-cookie'] && connection.code == 200)
+    end
+
+    def users
+      resource(:user).new(self)
+    end
+
+    def projects
+      resource(:project).new(self)
+    end
+
+    def issues
+      resource(:issue).new(self)
+    end
+
+    def tags
+      resource(:tag).new(self)
+    end
+
+    private
+
+      def resource(resource_name)
+        Youtrack.const_get(resource_name.to_s.capitalize)
+      end
+  end
+end

data/lib/youtrack/resources/base.rb

@@ -0,0 +1,54 @@
+module Youtrack
+  class Base
+    include HTTParty
+
+    # The base route URL
+    attr_accessor :base_url
+
+    # The Server Endpoint
+    attr_accessor :service
+
+    # Stores the response of the previous request
+    attr_accessor :response
+
+
+    def initialize(client)
+      @service = client
+      @base_url = @service.endpoint
+      self.class.debug_output($stderr) if client.debug
+    end
+
+    protected
+
+      def join(*args)
+        File.join(*args)
+      end
+
+      def prepare_options(options={})
+        options[:headers] ||= {}
+        options[:headers]['Cookie'] = service.cookies['Cookie']
+        options
+      end
+      
+      def post(path, options={})
+        options = prepare_options(options)
+        @response = self.class.post( join(base_url, path), options )
+      end
+
+      def put(path, options={})
+        options = prepare_options(options)
+        @response = self.class.put( join(base_url, path), options )
+      end
+
+      def get(path, options={})
+        options = prepare_options(options)
+        @response = self.class.get( join(base_url, path), options )
+      end
+
+      def delete(path, options={})
+        options = prepare_options(options)
+        @response = self.class.delete( join(base_url, path), options )
+      end
+
+  end
+end

data/lib/youtrack/resources/issue.rb

@@ -0,0 +1,169 @@
+require 'net/http/post/multipart'
+require 'uri'
+
+module Youtrack
+  class Issue < Base
+
+
+    # ==================
+    # USER Methods
+    # ==================
+    
+
+    # Create a New Issue
+    # project  string  ID of a project to add new issue to.
+    # summary  string  Short summary for the new issue.
+    # description  string  Description for the new issue.
+    # attachments  file in "multipart/form-data" format  One or several files in "multipart/form-data" format that should be attached to the new issue.
+    # permittedGroup   string  Set visibility for the new issue, that is: Specify a user group to which the issue will be visible.
+    #
+    # Hack: the body has to be set to empty so that HTTParty sends a Content-Length header, which Youtrack requires
+    #
+    # API-Success: Returns a 201 created wit hthe location header set
+    #
+    # Returns the response object
+    def create(attributes={})
+      put("issue", query: attributes, body: {})
+      response
+    end
+
+    def find(issue_id)
+      get("issue/#{issue_id}")
+      response.parsed_response
+    end
+
+    def count(filter)
+      get("issue/count?filter=#{URI.encode(filter)}")
+      response.parsed_response
+    end
+
+    def get_history_for(issue_id)
+      get("issue/#{issue_id}/history")
+      response.parsed_response
+    end
+
+    def get_changes_for(issue_id)
+      get("issue/#{issue_id}/changes")
+      response.parsed_response
+    end
+
+    def exists?(issue_id)
+      get("issue/#{issue_id}/exists")
+      response.code == 200
+    end
+
+    def get_attachments_for(issue_id)
+      get("issue/#{issue_id}/attachment")
+      response.parsed_response
+    end
+
+    def get_comments_for(issue_id)
+      get("issue/#{issue_id}/comment")
+      response.parsed_response
+    end
+
+    def get_links_for(issue_id)
+      get("issue/#{issue_id}/link")
+      response.parsed_response
+    end
+
+
+
+    # issueID  string  ID of an issue that should be updated.
+    # summary  string  New summary for the specified issue.
+    # description  string  Updated description for the specified issue.
+    def update(issue_id, attributes={})
+      post("issue/#{issue_id}", query: attributes)
+      response.parsed_response
+    end
+
+    def destroy(issue_id)
+      delete("issue/#{issue_id}")
+      response
+    end
+
+    def add_attachment(issue_id, data, content_type, filename)
+      url = URI.parse(join(base_url, "issue/#{issue_id}/attachment"))
+      req = Net::HTTP::Post::Multipart.new( url.path, "file" => UploadIO.new(data, content_type, filename))
+      req['Cookie'] = service.cookies['Cookie']
+      http = Net::HTTP.new(url.host, url.port)
+      http.set_debug_output($stderr) if service.debug
+      
+      if url.scheme == 'https'
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+
+      response = http.request(req)
+      response
+    end
+
+
+    def add_comment(issue_id, attributes={})
+      post("issue/#{issue_id}/execute", query: attributes)
+      response
+    end
+
+    # Get a list of issues for a search query.
+    #
+    # attributes
+    #      filter  string   A query to search for issues.
+    #      with    string   List of fields that should be included in the result.
+    #      max     integer  Maximum number of issues to get. If not provided, only 10 issues will be returned by default.
+    #      after   integer  A number of issues to skip before getting a list of issues.
+    #
+    def list attributes={}
+      attributes[:max] ||= 10
+      get("issue?#{URI.encode_www_form(attributes)}")
+    end
+
+    # Get the list of available work items for a particular issue.
+    #
+    # issue_id   string  youtrack ticket id
+    #
+    def get_work_items_for(issue_id)
+      get("issue/#{issue_id}/timetracking/workitem/")
+      response.parsed_response
+    end
+
+    # Add new work item to issue
+    #
+    # issue_id   string  youtrack ticket id
+    # attributes    hash
+    #      user         string  login name of the user who will be set as the author of the work item. (defaults to logged in user)
+    #      date         string  date and time of the new work item in ISO8601 time format (defaults to current date)
+    #      duration     string  Duration of the work item in minutes
+    #      description  string  Activity description
+    #
+    def add_work_item_to(issue_id, attributes={})
+      attributes = attributes.to_hash
+      attributes.symbolize_keys!
+      attributes[:date] ||= Date.current.iso8601
+      epoc_date = Date.parse(attributes[:date]).to_time.to_i * 1000
+      attributes[:user] ||= self.service.login
+      work_items = REXML::Element.new('workItems')
+      work_item = work_items.add_element('workItem')
+      work_item.add_element('author').add_attribute('login', attributes[:user])
+      work_item.add_element('date').add_text(epoc_date.to_s)
+      work_item.add_element('duration').add_text(attributes[:duration].to_s)
+      work_item.add_element('description').add_text(attributes[:description])
+      put("import/issue/#{issue_id}/workitems", body: work_items.to_s, :headers => {'Content-type' => 'text/xml'} )
+      response
+    end
+
+    # apply command
+    #
+    # issue_id   string  youtrack ticket id
+    # attributes   hash
+    #   command   string
+    #   comment   string
+    #   group   string
+    #   disableNotifications   boolean
+    #   runAs   string
+    #
+    def apply_command(issue_id, attributes={})
+      post("issue/#{issue_id}/execute", query: attributes)
+      response
+    end
+  end
+end