youtrack_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf83ce5a8edbb921abd47bbeed0298949224101d6ad492b0d8016c5298e6fb9e
+  data.tar.gz: 479af90f64ccb10ebd5ac1cb7931b12c2704dbf9ac75e1437f2d61fcd4a17bc2
+SHA512:
+  metadata.gz: 429008de43454915497287709edc27ee985d4f232afa6de71f907069859e518ab7c87a94af4d3a67d6ada2f922cf77a552e2340ddafba7bd2f85314f29b4b332
+  data.tar.gz: '08a34367fa8ef12fbd5a87272e5d6fa86134a832ad6a8ac4a985e1436cc5b8363e3cb01357e3dc139706d5ded1707e617631f1332d233a87dec10a88a3ad478f'

data/.github/workflows/specs.yml

@@ -0,0 +1,24 @@
+name: 🛡 Specs
+
+on: [push]
+
+jobs:
+  specs:
+    name: Specs
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7.6'
+          bundler-cache: true
+
+      - name: Run specs
+        run: |
+          bundle exec rspec

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+# rspec failure tracking
+.rspec_status
+.ruby-version
+.ruby-gemset
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### Changelog
+
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+#### v1.0.0
+
+- initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Shane Hofstetter
+
+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,112 @@
+![logo](https://user-images.githubusercontent.com/13404717/59300590-da2b6600-8c8f-11e9-82b2-ab3dc856ffdb.jpeg)
+
+# youtrack-rest-client
+
+Ruby client for the [Youtrack REST API](https://www.jetbrains.com/help/youtrack/standalone/youtrack-rest-api-reference.html)
+
+## Usage
+
+## Installation
+
+TBD
+
+### Authentication
+
+**With your permanent token (
+see [Manage-Permanent-Token](https://www.jetbrains.com/help/youtrack/incloud/Manage-Permanent-Token.html)):**
+
+```ruby
+require 'youtrack'
+
+# 1. create an instance, pass your youtrack instance url and access token
+youtrack = Youtrack::Client.new(base_url: "https://example.myjetbrains.com", token: "perm:your-token")
+
+# 2. make requests!
+youtrack.users.current.email
+```
+
+### [Users](https://www.jetbrains.com/help/youtrack/incloud/api-entity-User.html)
+
+```ruby
+
+# get the current user
+youtrack.users.current
+
+# get all users
+youtrack.users.all
+
+# search users
+youtrack.users.all("query" => "admin")
+
+# get a user by id
+youtrack.users.by_id('1-1')
+
+```
+
+### [Projects](https://www.jetbrains.com/help/youtrack/incloud/api-entity-Project.html)
+
+```ruby
+
+# get all projects
+youtrack.projects.all
+
+# search projects
+youtrack.projects.all(query: "DEMO")
+
+# get a project by its id
+youtrack.projects.by_id('0-0')
+
+```
+
+### [Issues](https://www.jetbrains.com/help/youtrack/incloud/api-entity-Issue.html)
+
+```ruby
+# search/list issues
+youtrack.issues.search('project: T1')
+```
+
+```ruby
+# get issue by id
+youtrack.issues.by_id('T1-2')
+```
+
+```ruby
+# delete an issue
+youtrack.issues.delete('2-2')
+```
+
+```ruby
+# create a new issue 
+youtrack.issues.create({
+                         summary: 'lorem ipsum',
+                         description: 'created using rest api',
+                         project: {
+                           id: '0-0'
+                         }
+                       })
+# you can also pass a model instance
+youtrack.issues.create(Youtrack::Models::Issue.new(summary: "demo issue",
+                                                   description: "demo issue description",
+                                                   project: client.projects.by_id("0-0")))
+
+
+```
+
+### [Commands](https://www.jetbrains.com/help/youtrack/incloud/api-entity-CommandList.html)
+
+```ruby
+# execute command for issue(s)
+youtrack.issues.command("State Open", client.issues.search("DEMO-12"))
+# pass the ids directly
+youtrack.issues.command("State Open", %w[T1-1 T1-2 T1-3])
+```
+
+## Contributing
+
+If you encounter any missing features or bugs, you're welcome to open an Issue! PRs are welcome too ;-)
+
+1. Fork it ( https://github.com/shanehofstetter/youtrack-rest-client-ruby/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request

data/lib/youtrack/client.rb

@@ -0,0 +1,78 @@
+require 'rest-client'
+require "active_support"
+require 'active_support/core_ext'
+
+module Youtrack
+  class Client
+    attr_reader :base_url, :token
+
+    def initialize(base_url:, token:)
+      @base_url = normalize_base_url(base_url)
+      @token = token
+      RestClient.log = $stdout if ENV["DEBUG"]
+    end
+
+    def users
+      @users ||= Resources::Users.new(client: self)
+    end
+
+    def issues
+      @issues ||= Resources::Issues.new(client: self)
+    end
+
+    def projects
+      @projects ||= Resources::Projects.new(client: self)
+    end
+
+    def get(path, options = {})
+      execute(:get, path, options)
+    end
+
+    def post(path, payload, options = {})
+      execute(:post, path, options.merge(payload: payload))
+    end
+
+    def delete(path, options = {})
+      execute(:delete, path, options)
+    end
+
+    def execute(method, path, options = {})
+      RestClient::Request.execute(
+        method: method,
+        url: request_url(path),
+        headers: default_headers
+                   .merge(options.delete(:headers) || {})
+                   .merge(params: options.delete(:params) || {}),
+        **options
+      )
+    rescue RestClient::Exception => e
+      if e.http_body.present?
+        e.message = e.http_body
+      end
+      raise e
+    end
+
+    private
+
+    def default_headers
+      {
+        "Authorization" => "Bearer #{token}",
+        'Content-Type' => :json
+      }
+    end
+
+    def request_url(path)
+      [base_url, path].join("")
+    end
+
+    def normalize_base_url(base_url)
+      if base_url.match(/\/$/)
+        base_url = base_url[0..-2]
+      end
+      unless base_url.match(/api$/i)
+        base_url += "/api"
+      end
+      base_url
+    end
+  end
+end

data/lib/youtrack/models/base.rb

@@ -0,0 +1,114 @@
+module Youtrack
+  module Models
+    class Base
+
+      class Field
+        attr_accessor :name, :extended, :model, :type
+
+        def initialize(name:, extended: nil, model: nil, type: nil)
+          @name = name
+          @extended = extended
+          @model = model
+          @type = type
+        end
+
+        def extended?
+          extended
+        end
+
+        def to_query
+          if model.present?
+            model_fields = model.minimal_fields
+            "#{name}(#{model_fields.map(&:to_query).join(",")})"
+          else
+            name
+          end
+        end
+
+        def to_s
+          "Field name=#{name} extended=#{extended} model=#{model} type=#{type}"
+        end
+
+        def attr_name
+          name.underscore
+        end
+      end
+
+      class << self
+        attr_reader :fields
+
+        def all_fields
+          fields
+        end
+
+        def minimal_fields
+          fields.reject(&:extended?)
+        end
+
+        def field(name, extended: false)
+          @fields ||= []
+          @fields << Field.new(name: name, extended: extended)
+          register_field_as_attr(@fields.last)
+        end
+
+        def has_many(name, model, extended: true)
+          @fields ||= []
+          @fields << Field.new(name: name, extended: extended, model: model, type: :many)
+          register_field_as_attr(@fields.last)
+        end
+
+        def has_one(name, model, extended: true)
+          @fields ||= []
+          @fields << Field.new(name: name, extended: extended, model: model, type: :one)
+          register_field_as_attr(@fields.last)
+        end
+
+        def register_field_as_attr(field)
+          attr_accessor field.attr_name
+        end
+
+        def from_json(json)
+          if json.is_a?(Array)
+            json.map { |item| from_json(item) }
+          else
+            self.new.tap do |instance|
+              json.each do |key, value|
+                field = fields.find { |f| f.name == key }
+                next unless field.present?
+                field_value = field.model.present? && value.present? ? field.model.from_json(value) : value
+                instance.send(field.attr_name + "=", field_value)
+              end
+            end
+          end
+        end
+      end
+
+      def initialize(attrs = {})
+        attrs.each do |k, v|
+          next unless respond_to?(k.to_s + "=")
+          send(k.to_s + "=", v)
+        end
+      end
+
+      def to_h
+        self.class.all_fields.map do |field|
+          value = send(field.attr_name)
+          if field.model.present?
+            if value.is_a?(Array)
+              value = value.map(&:to_h)
+            elsif value.present?
+              value = value.to_h
+            end
+          end
+          [field.attr_name, value]
+        end.to_h
+      end
+      alias_method :to_hash, :to_h
+
+      def as_payload
+        to_h.compact.to_json
+      end
+
+    end
+  end
+end

data/lib/youtrack/models/field_style.rb

@@ -0,0 +1,11 @@
+module Youtrack
+  module Models
+    class FieldStyle < Base
+
+      field "id"
+      field "background"
+      field "foreground"
+
+    end
+  end
+end

data/lib/youtrack/models/issue.rb

@@ -0,0 +1,26 @@
+module Youtrack
+  module Models
+    class Issue < Base
+
+      field "id"
+      field "idReadable"
+      field "numberInProject"
+      field "created"
+      field "updated"
+      field "resolved"
+      has_one "project", Project, extended: false
+      field "summary"
+      field "description"
+
+      has_one "reporter", User, extended: true
+      has_one "updater", User, extended: true
+      field "wikifiedDescription", extended: true
+      field "usesMarkdown", extended: true
+      has_many "fields", IssueCustomField, extended: true
+      field "isDraft", extended: true
+      has_many "tags", Tag, extended: true
+      # has_many "links", Link, extended: true
+      # has_many "comments", Comment, extended: true
+    end
+  end
+end

data/lib/youtrack/models/issue_custom_field.rb

@@ -0,0 +1,11 @@
+module Youtrack
+  module Models
+    class IssueCustomField < Base
+
+      field "id"
+      field "name"
+      has_one "value", IssueCustomFieldValue, extended: false
+
+    end
+  end
+end

data/lib/youtrack/models/issue_custom_field_value.rb

@@ -0,0 +1,19 @@
+module Youtrack
+  module Models
+    class IssueCustomFieldValue < Base
+
+      field "id"
+      field "name"
+      field "localizedName"
+      field "fullName"
+      field "login"
+      field "avatarUrl"
+      field "isResolved"
+      field "text"
+      field "minutes"
+      field "presentation"
+      has_one "color", FieldStyle, extended: false
+
+    end
+  end
+end

data/lib/youtrack/models/project.rb

@@ -0,0 +1,21 @@
+module Youtrack
+  module Models
+    class Project < Base
+
+      field "id"
+      field "name"
+      field "shortName"
+      field "description"
+      field "archived"
+
+      has_one "createdBy", User, extended: true
+      # has_many "fields", Field, extended: true
+      field "fromEmail", extended: true
+      field "hubResourceId", extended: true
+      field "iconUrl", extended: true
+      field "timeTrackingEnabled", extended: true
+      has_one "leader", User, extended: true
+
+    end
+  end
+end

data/lib/youtrack/models/tag.rb

@@ -0,0 +1,13 @@
+module Youtrack
+  module Models
+    class Tag < Base
+
+      field "id"
+      field "name"
+      field "untagOnResolve"
+
+      has_one "owner", User
+
+    end
+  end
+end

data/lib/youtrack/models/user.rb

@@ -0,0 +1,21 @@
+module Youtrack
+  module Models
+    class User < Base
+
+      field "id"
+      field "email"
+      field "fullName"
+      field "login"
+      field "name"
+
+      field "avatarUrl", extended: true
+      field "banned", extended: true
+      field "online", extended: true
+      field "guest", extended: true
+      field "jabberAccountName", extended: true
+      field "ringId", extended: true
+
+      has_many "tags", Tag
+    end
+  end
+end

data/lib/youtrack/resources/base.rb

@@ -0,0 +1,54 @@
+module Youtrack
+  module Resources
+    class Base
+      attr_reader :client
+
+      def initialize(client:)
+        @client = client
+      end
+
+      def get_resource_with_fields(fields, path, options = {})
+        query_params = query_params_for_fields(fields).merge(options.delete(:params) || {})
+        response = client.get(path, { params: query_params })
+        deserialize_response(response)
+      end
+
+      def post_resource_with_fields(fields, path, data)
+        response = client.post(path, prepare_payload(data), { params: query_params_for_fields(fields) })
+        deserialize_response(response)
+      end
+
+      def delete_resource(path)
+        client.delete(path)
+        true
+      end
+
+      def query_params_for_fields(fields)
+        return {} unless fields.present?
+        { fields: fields.map(&:to_query).join(",") }
+      end
+
+      def deserialize_response(response)
+        $stdout.puts response.body if ENV["DEBUG"]
+        json = JSON.parse(response.body)
+        model.from_json(json)
+      end
+
+      def prepare_payload(data)
+        if data.respond_to?(:deep_transform_keys)
+          data = data.deep_transform_keys { |k| k.to_s.camelize(:lower) }
+        end
+        if data.respond_to?(:as_payload)
+          data = data.as_payload
+        elsif data.respond_to?(:to_json)
+          data = data.to_json
+        end
+        data
+      end
+
+      def self.descendants
+        ObjectSpace.each_object(Class).select { |klass| klass < self }
+      end
+    end
+  end
+end

data/lib/youtrack/resources/issues.rb

@@ -0,0 +1,44 @@
+module Youtrack
+  module Resources
+    class Issues < Base
+      PATHS = OpenStruct.new(
+        issue: '/issues/%{id}',
+        issues: '/issues',
+        commands: '/commands',
+      )
+
+      def by_id(id)
+        get_resource_with_fields(model.all_fields, PATHS.issue % { id: id })
+      end
+
+      def search(query, params = {})
+        issues = get_resource_with_fields(model.minimal_fields, PATHS.issues, { params: { query: query }.merge(params) })
+        return issues if issues.is_a?(Array)
+        [issues]
+      end
+
+      def delete(id)
+        delete_resource(PATHS.issue % { id: id })
+      end
+
+      # @param issue either a hash, json string or Issue instance
+      def create(issue)
+        post_resource_with_fields(model.all_fields, PATHS.issues, issue)
+      end
+
+      # @param issues either a list of ids or a list of Issue instances
+      def command(command, issues = [])
+        issues = issues.map { |item| { id: item.respond_to?("id") ? item.id : item } }
+        post_resource_with_fields([], PATHS.commands, { query: command, issues: issues })
+        true
+      end
+
+      private
+
+      def model
+        Models::Issue
+      end
+
+    end
+  end
+end

data/lib/youtrack/resources/projects.rb

@@ -0,0 +1,25 @@
+module Youtrack
+  module Resources
+    class Projects < Base
+      PATHS = OpenStruct.new(
+        projects: '/admin/projects',
+        project: '/admin/projects/%{id}',
+      )
+
+      def all(params = {})
+        get_resource_with_fields(model.minimal_fields, PATHS.projects, params: params)
+      end
+
+      def by_id(id)
+        get_resource_with_fields(model.all_fields, PATHS.project % { id: id })
+      end
+
+      private
+
+      def model
+        Models::Project
+      end
+
+    end
+  end
+end

data/lib/youtrack/resources/users.rb

@@ -0,0 +1,30 @@
+module Youtrack
+  module Resources
+    class Users < Base
+      PATHS = OpenStruct.new(
+        current: '/users/me',
+        users: '/users',
+        user: '/users/%{id}'
+      )
+
+      def current
+        get_resource_with_fields(model.all_fields, PATHS.current)
+      end
+
+      def all(params = {})
+        get_resource_with_fields(model.minimal_fields, PATHS.users, params: params)
+      end
+
+      def by_id(id)
+        get_resource_with_fields(model.all_fields, PATHS.user % { id: id })
+      end
+
+      private
+
+      def model
+        Models::User
+      end
+
+    end
+  end
+end

data/lib/youtrack/version.rb

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

data/lib/youtrack.rb

@@ -0,0 +1,7 @@
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Youtrack
+  # Your code goes here...
+end

data/lib/youtrack_client.rb

@@ -0,0 +1 @@
+require 'youtrack'

data/youtrack_client.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'youtrack/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "youtrack_client"
+  gem.version       = Youtrack::VERSION
+  gem.authors       = ["Shane Hofstetter"]
+  gem.email         = ["shane.hofstetter@gmail.com"]
+  gem.description   = %q{REST API client for youtrack from jetbrains}
+  gem.summary       = %q{youtrack REST API client}
+  gem.homepage      = "https://github.com/shanehofstetter/youtrack-rest-client-ruby"
+  gem.metadata["homepage_uri"] = gem.homepage
+  gem.metadata["source_code_uri"] = "https://github.com/shanehofstetter/youtrack-rest-client-ruby"
+  gem.metadata["changelog_uri"] = "https://github.com/shanehofstetter/youtrack-rest-client-ruby/blob/main/CHANGELOG.md"
+  gem.metadata["bug_tracker_uri"] = "https://github.com/shanehofstetter/youtrack-rest-client-ruby/issues"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.required_ruby_version = Gem::Requirement.new(">= 2.1.0")
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "rest-client", '~> 2.0'
+  gem.add_runtime_dependency "activesupport", '> 5.0.0'
+  gem.add_runtime_dependency "zeitwerk", '~> 2.6'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: youtrack_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shane Hofstetter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: REST API client for youtrack from jetbrains
+email:
+- shane.hofstetter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/specs.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/youtrack.rb
+- lib/youtrack/client.rb
+- lib/youtrack/models/base.rb
+- lib/youtrack/models/field_style.rb
+- lib/youtrack/models/issue.rb
+- lib/youtrack/models/issue_custom_field.rb
+- lib/youtrack/models/issue_custom_field_value.rb
+- lib/youtrack/models/project.rb
+- lib/youtrack/models/tag.rb
+- lib/youtrack/models/user.rb
+- lib/youtrack/resources/base.rb
+- lib/youtrack/resources/issues.rb
+- lib/youtrack/resources/projects.rb
+- lib/youtrack/resources/users.rb
+- lib/youtrack/version.rb
+- lib/youtrack_client.rb
+- youtrack_client.gemspec
+homepage: https://github.com/shanehofstetter/youtrack-rest-client-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shanehofstetter/youtrack-rest-client-ruby
+  source_code_uri: https://github.com/shanehofstetter/youtrack-rest-client-ruby
+  changelog_uri: https://github.com/shanehofstetter/youtrack-rest-client-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/shanehofstetter/youtrack-rest-client-ruby/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: youtrack REST API client
+test_files: []