ticket_abstractor_client 0.1

data/README.md

@@ -0,0 +1,93 @@
+# TicketAbstractorClient
+
+Client for accessing to a TicketAbstractor service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ticket_abstractor_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ticket_abstractor_client
+
+## Usage
+
+Initialize:
+
+    client = TicketAbstractorClient.initialize_client('http://ticket.abstractor.url')
+
+Access clients:
+
+    client.jira
+    client.brouha
+    client.itrc
+
+### Jira
+
+Grab issue:
+
+    client.jira.get_issue 'IFS-123'
+    client.jira.get_issue_status 'IFS-123' => 'Open'
+    
+Create issue (summary, description and issuetype fields are required):
+
+    options = { project: "IFS", summary: "Summary", description: "Desc", issuetype: "Bug"}
+    client.jira.create_issue options
+
+Create issue with an attachment:
+
+    options = { project: "IFS", summary: "Summary", description: "Desc", issuetype: "Bug"}
+    attachment = File.new('file.png', 'rb')
+    client.jira.create_issue options, attachment
+    
+Update issue (issuekey field is required):
+
+    client.jira.update_issue({ issuekey: 'IFS-46728', description: 'new description' })
+    
+Attach the file to issue:
+
+    attachment = File.new('file.png', 'rb')
+    client.jira.update_issue({ issuekey: 'IFS-46728' }, attachment)
+    
+### Brouha
+
+Grab issue:
+
+    client.brouha.get_issue '12'
+    
+### iTRC
+
+Find apps:
+
+    client.itrc.list_apps
+    client.itrc.find_app 'itrc'
+    
+Find app_groups:
+
+    client.itrc.list_app_groups
+    client.itrc.find_app_group 'app-mgmt-tools'
+    
+Find business units:
+
+    client.itrc.list_business_units
+    client.itrc.find_business_unit 3
+    
+Find departments:
+
+    client.itrc.list_departments
+    client.itrc.find_department 4
+    
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/lib/ticket_abstractor_client/brouha_client.rb

@@ -0,0 +1,5 @@
+class TicketAbstractorClient::BrouhaClient < TicketAbstractorClient::Client
+  def get_issue(issue_key)
+    get "ticket/brouha/#{issue_key}"
+  end
+end

data/lib/ticket_abstractor_client/client.rb

@@ -0,0 +1,19 @@
+class TicketAbstractorClient::Client
+  def initialize(base_url)
+    @base_url = base_url
+  end
+
+  def get(url, args = {}, params = {})
+    params.merge! args: args.to_json
+    response = RestClient.get("#{@base_url}/#{url}", params: params)
+
+    JSON.parse response
+  end
+
+  def post(url, args = {}, params = {})
+    params.merge! args: args.to_json
+    response = RestClient.post("#{@base_url}/#{url}", params)
+
+    JSON.parse response
+  end
+end

data/lib/ticket_abstractor_client/itrc_client.rb

@@ -0,0 +1,33 @@
+class TicketAbstractorClient::ItrcClient < TicketAbstractorClient::Client
+  def list_apps(page = 1, per_page = 20)
+    get 'itrc/list_apps', page: page, per_page: per_page
+  end
+
+  def find_app(id)
+    get 'itrc/find_app', id: id
+  end
+
+  def list_app_groups(page = 1, per_page = 20)
+    get 'itrc/list_app_groups', page: page, per_page: per_page
+  end
+
+  def find_app_group(id)
+    get 'itrc/find_app_group', id: id
+  end
+
+  def list_business_units(page = 1, per_page = 20)
+    get 'itrc/list_business_units', page: page, per_page: per_page
+  end
+
+  def find_business_unit(id)
+    get 'itrc/find_business_unit', id: id
+  end
+
+  def list_departments(page = 1, per_page = 20)
+    get 'itrc/list_departments', page: page, per_page: per_page
+  end
+
+  def find_department(id)
+    get 'itrc/find_department', id: id
+  end
+end

data/lib/ticket_abstractor_client/jira_client.rb

@@ -0,0 +1,71 @@
+class TicketAbstractorClient::JiraClient < TicketAbstractorClient::Client
+  ##
+  # Get jira issue by issue id
+  #
+  # == Parameters:
+  # issue_key:
+  #   issue id in jira
+  #
+  # == Example:
+  #   >> client.jira.get_issue 'IFS-123'
+  #   => { 'id' => 'IFS-123', 'description' => '...', ... }
+  def get_issue(issue_key)
+    get "ticket/jira/#{issue_key}"
+  end
+
+  ##
+  # Get the status of jira issue by issue id
+  #
+  # == Parameters:
+  # issue_key:
+  #   issue id in jira
+  #
+  # == Example:
+  #   >> client.jira.get_issue_status 'IFS-123'
+  #   => 'Resolved'
+  def get_issue_status(issue_key)
+    get_issue(issue_key)['status']
+  end
+
+  def get_issues_by_query(query)
+    get 'jira/get_issues_by_query', query: query
+  end
+
+  def get_users_by_query(query)
+    get 'jira/get_users_by_query', query: query
+  end
+
+  def get_issues_statuses_by_search_query(issues_id)
+    get 'jira/get_issues_statuses_by_search_query', issues_id: issues_id
+  end
+
+  ##
+  # Get issues by jira filter
+  #
+  # == Parameters:
+  # filter_id:
+  #   filter id in jira
+  #
+  # == Example:
+  #   >> client.jira.get_issues_by_filter 24320
+  #   => [{ 'id' => 'ID-1', ... }, { 'id' => 'ID-2', ... }]
+  def get_issues_by_filter(filter_id)
+    get 'jira/get_issues_by_filter', filter_id: filter_id
+  end
+
+  def get_fields_by_project(project_key)
+    get 'jira/get_fields_by_project', project_key: project_key
+  end
+
+  def create_issue(opts = {}, *attachments)
+    post('jira/create_issue', { opts: opts }, attachments: attachments)
+  end
+
+  def update_issue(opts = {}, *attachments)
+    post('jira/update_issue', { opts: opts }, attachments: attachments)
+  end
+
+  def add_comment(issue_key, comment)
+    post 'jira/add_comment', issue_key: issue_key, comment: comment
+  end
+end

data/lib/ticket_abstractor_client/version.rb

@@ -0,0 +1,3 @@
+module TicketAbstractorClient
+  VERSION = '0.1'
+end

data/lib/ticket_abstractor_client.rb

@@ -0,0 +1,25 @@
+module TicketAbstractorClient
+  def self.initialize_client(url)
+    @url = url
+    self
+  end
+
+  def self.jira
+    @jira_client ||= JiraClient.new(@url)
+  end
+
+  def self.brouha
+    @brouha_client ||= BrouhaClient.new(@url)
+  end
+
+  def self.itrc
+    @itrc ||= ItrcClient.new(@url)
+  end
+end
+
+require 'rest_client'
+require 'ticket_abstractor_client/version'
+require 'ticket_abstractor_client/client'
+require 'ticket_abstractor_client/jira_client'
+require 'ticket_abstractor_client/brouha_client'
+require 'ticket_abstractor_client/itrc_client'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ticket_abstractor_client
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- rsamoilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: Get access to Jira and Brouha ticketing systems through the single service
+email:
+- rsamoilov@productengine.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ticket_abstractor_client.rb
+- lib/ticket_abstractor_client/jira_client.rb
+- lib/ticket_abstractor_client/itrc_client.rb
+- lib/ticket_abstractor_client/brouha_client.rb
+- lib/ticket_abstractor_client/client.rb
+- lib/ticket_abstractor_client/version.rb
+- README.md
+homepage: http://github.com/rsamoilov/ticket_abstractor_client
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: Client for the Ticket Abstractor service
+test_files: []