jira-rest 0.1.42

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTMxZWE1ZjNhOTI0Mzc5ZmNmODUyZWZhYTgyMzY4NGQ1NmM3OWM3OA==
+  data.tar.gz: !binary |-
+    ZDc1OTJjYzc5MTNiMzNjYThiYTllOWM3OTRjMmIwNzlhNmU2YzA1OA==
+SHA512:
+  metadata.gz: !binary |-
+    OGM5ODI0ZGFjMTNhM2U3NDFmZTc3Nzg3MWM5MjY2YjQ0ZDNhMmYwNmExNTZh
+    YTU2OGI4MGQzYmY1ZGZjZWQwOTZjMTFkMzQ5YmUxN2I5MGY2YWM1NGIzNzY0
+    OTQyZTcwYzgzMDY3MzQ4MTFkNTcwMzUyYzAxNTY0MmRlNGVhZjY=
+  data.tar.gz: !binary |-
+    YTFjMTcwZTZiYmMxN2Q0MmQwYzhkNzE5ZWY4MDAwZjQ3MTI5ZjYyMGRiZGQx
+    M2RlYmEzNTZmNTQ0OWQyYjhmYzgyOGY5ZTEwNmQxMTdkOGI1NzI5NzI3MmJi
+    NTllYjg0OGY0OWZiZGViYWZjYzIyY2MwOTgwMmIwMjRlOGU1ZTY=

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 tiago.nobre
+
+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,61 @@
+jira-rest
+=========
+
+[![Build Status](https://travis-ci.org/macwadu/jira-rest.png?branch=master)](https://travis-ci.org/macwadu/jira-rest)   [![Code Climate](https://codeclimate.com/github/macwadu/jira-rest.png)](https://codeclimate.com/github/macwadu/jira-rest) [![Dependency Status](https://gemnasium.com/macwadu/jira-rest.png)](https://gemnasium.com/macwadu/jira-rest.png) [![Coverage Status](https://coveralls.io/repos/macwadu/jira-rest/badge.png)](https://coveralls.io/r/macwadu/jira-rest)
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jira-rest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jira-rest
+
+## Usage
+
+    require 'jira-rest'
+
+    @jira = JiraRest::Client.new(jira_host, username, password) 
+    
+  **Query by hash**
+    
+    hash_query = {:project => 'DEMO', :status => '"in progress", Open'}
+    @jira.search.query_by_hash(hash_query)
+    
+    optional:
+    @jira.search.query_by_hash(hash_query, return_fields, maxresults)
+  
+  **Query by jql string** 
+    
+    jql_query = "project in (DEMO) AND status in ("in progress", Open)"
+    @jira.search.jqlquery(jql_query)
+    
+    optional:
+    @jira.search.jqlquery(jql_query, return_fields, maxresults)
+  
+  **Search by issue key**
+  
+    @jira.search.issue "JRA-9"
+    
+   
+  **Get filter issues**
+  
+    @jira.search.filter "12843"
+
+
+## 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/jirarest.rb

@@ -0,0 +1,9 @@
+require 'httparty'
+require 'base64'
+require 'timeout'
+
+require 'jirarest/client'
+require 'jirarest/search'
+
+#to_h is present on ruby 2.0.0
+require 'jirarest/struct' if RUBY_VERSION == '1.9.3'

data/lib/jirarest/client.rb

@@ -0,0 +1,119 @@
+module JiraRest
+
+  class Client
+    DEFAULT_FIELDS = 'key,summary'
+    MAXRESULTS = '300'
+
+    attr_accessor :token
+
+    Token = Struct.new(:url, :header)
+    Response = Struct.new(:success, :body, :error_msg, :optional)
+
+    def initialize(jira_host, username=nil, password=nil)
+
+      jira_url = "#{jira_host}/rest/api/latest/"
+
+      generate jira_url, username, password
+
+    end
+
+    def generate(url, username=nil, password=nil)
+      header = {'Content-Type' => 'application/json'}
+      header['Authorization'] = "Basic #{Base64.strict_encode64(username+':'+password)}" unless username.nil? and password.nil?
+      @token = Token.new(url, header)
+    end
+
+
+    def search
+      JiraRest::Search.new(self)
+    end
+
+
+    def self.get(url, header)
+      begin
+        p "Url: #{url}"
+        HTTParty.get(url, header)
+      rescue Exception::ArgumentError => e
+        p e + "/n #{url}"
+        return false
+      end
+    end
+
+
+
+
+    def self.construct_url(endpoint, params)
+      p "Query: #{params.jql}" unless params.jql.nil?
+      params.fields = DEFAULT_FIELDS if (params.fields.nil? or params.fields.to_s.empty?)
+      params.maxresults = MAXRESULTS if (params.maxresults.nil? or params.maxresults.to_s.empty?)
+
+      endpoint + '?' + encode_www_form(params.to_h.delete_if { |k, v| v.nil? }).to_s
+    end
+
+    def self.encode_www_form(enum)
+
+      enum.map do |k, v|
+        if v.nil?
+          URI.encode_www_form_component(k)
+        elsif v.respond_to?(:to_ary)
+          v.to_ary.map do |w|
+            str = URI.encode_www_form_component(k)
+            unless w.nil?
+              str << '='
+              str << w
+            end
+          end.join('&')
+        else
+          str = URI.encode_www_form_component(k)
+          str << '='
+          str << v.to_s
+        end
+      end.join('&')
+    end
+
+    #TODO refactor to use in all methods
+    def self.handle_response(response, key=nil)
+      raise ArgumentError, 'Response is not a HTTParty::Response' unless response.class == HTTParty::Response
+      case response.code
+        when 200
+          parsed_response = key.nil? ? response.parsed_response : response.parsed_response[key]
+          return Response.new(true, parsed_response, nil)
+        when (400..499)
+          msg = response['errorMessages'].nil? ? response.code : response['errorMessages'].join("\n")
+          return Response.new(false, response.response.message, msg)
+        else
+          return Response.new(false, nil, 'fail')
+      end
+    end
+
+    def self.parse_search_result(response, fields=nil)
+      code = response.code
+      response = response.parsed_response
+      case code
+        when 200
+          jira_tickets = []
+          if response.has_key? 'issues'
+            response['issues'].each do |tickets|
+              if !tickets['key'].nil? and !tickets['fields']['summary'].nil?
+                jira_tickets << [tickets['key'], tickets['fields']['summary'], tickets['self']]
+              end
+            end
+          elsif !fields.nil?
+            sss = ""
+             fields.split(',').each {|field|
+                p field  if response[field]
+                sss << response[field]  if response[field]
+
+             }
+                p sss
+          end
+          return Response.new(true, jira_tickets.sort_by { |x| x.first }, nil)
+        when (400..499)
+          msg = response['errorMessages'].nil? ? code : response['errorMessages'].join("\n")
+          return Response.new(false, nil, msg)
+        else
+          return Response.new(false, nil, 'fail')
+      end
+    end
+  end
+end

data/lib/jirarest/search.rb

@@ -0,0 +1,68 @@
+module JiraRest
+  class Search
+    Url = Struct.new(:jql, :fields, :maxresults)
+
+    def initialize(params)
+      @token = params.token
+    end
+
+
+    def issue(issue_id)
+
+      url = 'issue/' + issue_id.to_s
+      issue = Url.new
+      issue.fields = 'key,summary,issuetype,reporter,priority'
+      search_url = Client.construct_url @token.url + url, issue
+      response = Client.get search_url, @token.header
+      Client.handle_response(response)
+      #TODO parse issue result
+    end
+
+    #get tickets from filter id
+    #
+    # @param[Integer/String] if filter id
+    # @return[JiraRest::Response]
+    def filter(id)
+      url = 'filter/' + id.to_s
+      issue = Url.new
+      issue.fields = 'key,summary,issuetype,reporter,priority'
+      search_url = Client.construct_url @token.url + url, issue
+      response = Client.get search_url, @token.header
+      filter_url = Client.handle_response(response, 'searchUrl')
+
+      return filter_url unless filter_url.success
+
+      filter_response = Client.get filter_url.body, @token.header
+      Client.parse_search_result filter_response
+
+    end
+
+
+    #get tickets by hash
+    #
+    # @param[Hash] hash_tickets - verify,in progress, open, reopened, closed
+    # @param[String] return_fields default will be 'key,summary'
+    # @param[String] maxresults max number of results default will be 300
+    # @return[JiraRest::Response]
+    def query_by_hash(hash_tickets, return_fields=nil, maxresults=nil)
+      jql_string = hash_tickets.map { |k, v| "#{k} in (#{v})" }.join(' AND ')
+      search_url = Client.construct_url('search', Url.new(URI.encode(jql_string), return_fields, maxresults))
+
+      #search_url = construct_query URI.escape(jql_string), return_fields, maxresults
+      response = Client.get @token.url + search_url, @token.header
+      Client.parse_search_result(response)
+    end
+
+    #get tickets from by a jql query
+    #
+    # @param[String] jql_string - jql string
+    # @param[String] return_fields default will be 'key,summary'
+    # @param[String] maxresults max number of results default will be 300
+    # @return[JiraRest::Response]
+    def jqlquery(jql_string, return_fields=nil, maxresults=nil)
+      search_url = Client.construct_url('search', Url.new(URI.encode(jql_string), return_fields, maxresults))
+      response = Client.get @token.url + search_url, @token.header
+      Client.parse_search_result(response)
+    end
+  end
+end

data/lib/jirarest/struct.rb

@@ -0,0 +1,5 @@
+class Struct
+  def to_h
+    Hash[*members.zip(values).flatten]
+  end
+end

data/lib/jirarest/version.rb

@@ -0,0 +1,3 @@
+module JiraRest
+  VERSION = "0.1." + ENV['TRAVIS_BUILD_NUMBER']
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: jira-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.42
+platform: ruby
+authors:
+- tiago.l.nobre@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  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'
+description: ''
+email: tiago.l.nobre@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- LICENSE.txt
+- README.md
+- lib/jirarest.rb
+- lib/jirarest/client.rb
+- lib/jirarest/search.rb
+- lib/jirarest/struct.rb
+- lib/jirarest/version.rb
+homepage: http://github.com/macwadu/jira-rest
+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.2.2
+signing_key: 
+specification_version: 4
+summary: JIRA REST API
+test_files: []
+has_rdoc: yard