jira_report 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d75a222514b53f02ecde9f846ffaa4d6e57d7e8b
-  data.tar.gz: aa44fd5e372f0f52f5a6be0153045c36ae97579c
+  metadata.gz: 3a2cc760a498627ad4172cb75097419cd553ebbb
+  data.tar.gz: e73c6a9e1bc11770fb9a26159fe3b02960d2d090
 SHA512:
-  metadata.gz: 2e89eaaf3a2df8079c8094ce8ce4666fae5d9fc086f1e7bd52639fa72fe85f88e8312894af0eadd84f3cfe4aa5d83342311e22719da691afd1a3ee8e9182e719
-  data.tar.gz: 79052cbebede82b19f3ad00bc72f680f5158a559526e19e817e2191cb4a1a93cb306b122b71667d771f5dda2a2edd0c4923bece844ea0e7d4535896304e69a7d
+  metadata.gz: fbaf3b2ab946def5d299930734ffee1c2f9f320c55f7adcc53d60798590127cf6e9ebc2ce22b64eef03e90778ddb39592c4a7a0da782c6eb52e3c8aedb2aabe5
+  data.tar.gz: 6bc5650ad49443dfd03613f199db006b309654270377b066f359f03f7dd88094f6690c3f26cfa71e16ff31e3531d4ef1c2f62439462ef94d3737d163826ca37d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+#x.x.x
+ * Now user can pass url with `http` or `https` prefixes.
+ * Now port and path are correctly resolved in url.
+ * `jira-report` cli becomes more user friendly.
+
 #0.1.3
  * Fixed error when configuration file not exist.
  * Now version is properly printed.

data/README.md

@@ -9,16 +9,16 @@ $ gem install jira_report
 
 ##Usage
 
-Just run it. `jira-report` will ask you your jira location, who you are and what's your password:
+Just run it. `jira-report` will ask your jira site address, who you are and what's your password:
 
 ```
 $ jira-report
-Jira url: jira.company.com
-Jira username: admin
-Jira password:
-Querying jira...
+Jira site address: https://jira.company.com
+Username for 'https://jira.company.com': admin
+Password for 'https://jira.company.com':
+Connecting to 'https://jira.company.com'. Pls wait...
 
-Jira activity report for [admin]:
+What was [admin] doing:
 
 Created: 2
   WFM-7180 - Provide static context for log property in BasicHashAnalyzer
@@ -46,7 +46,7 @@ Closed: 5
 
 `url`, `username`, `password` and some other parameters can be added to [configuration file](#configuration). Also you can use mixed approach (keep some options in file, others enter from command line). For example if you do not want to keep password in configuration file, just don't, you will be asked.
 
-Also you can use it directly in ruby:
+Also you can use it directly in ruby code:
 
 ```ruby
 require 'jira_report'
@@ -82,7 +82,7 @@ username=username
 password=s3cr3t
 ```
 
-all those are optional and if not specified user will be asked to enter it from command line.
+You may pass all those options (or some of them) in command line mode.
 
 Period is set by two options `period_from` and `period_till`. Both options support [advanced jira searching](https://confluence.atlassian.com/display/JIRA/Advanced+Searching) and accept dates, jira functions, aliasing. For example:
 

data/lib/jira_report/cli.rb

@@ -43,7 +43,7 @@ module JiraReport
         @config[:url], @config[:username], @config[:password]
       )
 
-      puts "\nQuerying jira..."
+      puts "\nConnecting to '#{@config[:url]}'. Pls wait..."
 
       created = reporter.created(
         @config[:usr], @config[:period_from], @config[:period_till]
@@ -58,7 +58,7 @@ module JiraReport
         @config[:usr], @config[:period_from], @config[:period_till]
       )
 
-      puts "\nJira activity report for [#{@config[:usr]}]:"
+      puts "\nWhat was [#{@config[:usr]}] doing:"
 
       puts "\nCreated: #{created.length}"
       print_issues(created)
@@ -102,9 +102,9 @@ module JiraReport
     # Reads required options from user input if those
     # were missed.
     def ask_missing_options
-      @config[:url] = ask('Jira url: ') unless @config[:url]
-      @config[:username] = ask('Jira username: ') unless @config[:username]
-      @config[:password] = ask('Jira password: '){
+      @config[:url] = ask('Jira site address: ') unless @config[:url]
+      @config[:username] = ask("Username for '#{@config[:url]}': ") unless @config[:username]
+      @config[:password] = ask("Password for '#{@config[:url]}': "){
         STDIN.noecho(&:gets).chomp!
       } unless @config[:password]
       if !@config[:period_from] && !@config[:period_till]

data/lib/jira_report/reporter.rb

@@ -20,15 +20,21 @@ module JiraReport
   #   # from two weeks ago and ending one week ago.
   #   reopened = reporter.reopened('usr', '-2w', '-1w')
   class Reporter
+    REST_API_SEARCH_URL = 'rest/api/2/search?'
+
     # Initializes reporter.
     #
     # ==== Attributes
     #
-    # * +url+ - jira URL in `jira.company.com` format.
+    # * +site+ - jira site address.
     # * +usr+ - jira username.
     # * +pass+ - jira password.
-    def initialize(url, usr, pass)
-      @search_url = jira_api_url(url, usr, pass);
+    def initialize(site, usr, pass)
+      fail 'url can\'t be nil' unless site
+      fail 'usr can\'t be nil' unless usr
+      fail 'pass can\'t be nil' unless pass
+
+      @search_url = jira_api_url(site, usr, pass);
     end
 
     # Queries created issues by usr in specified period.
@@ -90,9 +96,29 @@ module JiraReport
 
     private
 
-    # Returns jira rest api search url.
-    def jira_api_url(url, username, password)
-      "http://#{username}:#{password}@#{url}/rest/api/2/search?"
+    # Returns jira full rest api search url
+    def jira_api_url(site, username, password)
+      url = format_url(site, username, password)
+      "#{url}/#{REST_API_SEARCH_URL}"
+    end
+
+    # Formats url in the following format:
+    #  scheme://username:password@site
+    #
+    # If `site` parameter does not define scheme `http` will be used.
+    def format_url(site, username, password)
+      s = site.dup
+      if !s.start_with? 'http'
+        s = "http://#{s}"
+      end
+
+      u = URI.parse(s)
+
+      <<-EOU.gsub(/\s+/, '').strip
+        #{u.scheme + '://' if u.scheme}
+        #{username}:#{password}@
+        #{u.host}:#{u.port}#{u.path}
+      EOU
     end
 
     # Prepares jql query based on parameters to

data/lib/jira_report/version.rb

@@ -1,3 +1,3 @@
 module JiraReport
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/jira_report/reporter_spec.rb

@@ -2,7 +2,19 @@ require 'spec_helper'
 
 module JiraReport
   describe JiraReport do
-    let(:jrep) { Reporter.new('url', 'admin', '*****') }
+    let(:jrep) { Reporter.new('site', 'admin', '*****') }
+
+    describe '#new' do
+      it 'raises error if site is nil' do
+        expect{ Reporter.new(nil, '1', '2') }.to raise_error RuntimeError
+      end
+      it 'raises error if usr is nil' do
+        expect{ Reporter.new('mysite', nil, '2') }.to raise_error RuntimeError
+      end
+      it 'raises error if pas is nil' do
+        expect{ Reporter.new('mysite', 'usr', nil) }.to raise_error RuntimeError
+      end
+    end
 
     describe '#query_issues' do
       it 'should throw exception' do
@@ -16,29 +28,54 @@ module JiraReport
     end
 
     describe '#jira_api_url' do
-      def jira_api_url(url=nil, user=nil, pass=nil)
-        jrep.send(:jira_api_url, url, user, pass)
+      def jira_api_url(site=nil, user=nil, pass=nil)
+        jrep.send(:jira_api_url, site, user, pass)
       end
 
-      it 'is an http url' do
-        url = jira_api_url
-        expect(url).not_to be nil
-        expect(url).to start_with 'http'
+      it 'ends with jira rest api search url' do
+        expect(jira_api_url 'url', 'usr', 'pas').
+          to end_with Reporter::REST_API_SEARCH_URL
       end
 
-      it 'uses rest api' do
-        expect(jira_api_url).to include('rest/api/2/search')
+      describe 'scheme' do
+        ['http', 'https'].each do |s|
+          it 'correctly detects scheme' do
+            site = "jira.mycom.com"
+            url = jira_api_url("#{s}://#{site}")
+            expect(url).to start_with "#{s}://"
+            expect(url).to include site
+          end
+        end
+
+        it 'is ok when no scheme passed' do
+          site = 'jira.mycom.com'
+          expect(jira_api_url(site)).to include site
+        end
       end
 
-      context 'when we use url, username and password' do
-        let(:usr) { 'admin_username' }
-        let(:url) { 'jira.mycompany.url' }
-        let(:pas) { '*****' }
-        it 'contains url, username and password' do
-          url = jira_api_url(url, usr, pas)
-          expect(url).to include(url)
-          expect(url).to include(usr)
-          expect(url).to include(pas)
+      context 'when we define all parameters' do
+        let(:usr)    { 'admin_username' }
+        let(:pas)    { 'password' }
+        let(:host)   { 'localhost' }
+        let(:port)   {  8000 }
+        let(:path)   { 'myjira' }
+
+        def expected_url(prefix)
+          "#{prefix}#{usr}:#{pas}@#{host}:#{port}/#{path}/#{Reporter::REST_API_SEARCH_URL}"
+        end
+
+        ['http://', 'https://'].each do |prefix|
+          it "correctly prepares #{prefix} url" do
+            site = "#{prefix}#{host}:#{port}/#{path}"
+            url = jira_api_url(site, usr, pas)
+            expect(url).to eq ( expected_url prefix )
+          end
+        end
+
+        it 'correctly prepares url without scheme' do
+          site = "#{host}:#{port}/#{path}"
+          url = jira_api_url(site, usr, pas)
+          expect(url).to eq ( expected_url 'http://' )
         end
       end
     end
@@ -177,5 +214,4 @@ module JiraReport
       end
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jira_report
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Vitalii Elenhaupt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig