Merge branch 'release/1.2.5'

support enterprise github via command line options

.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+before_install:
+  - gem update --system
+  - gem --version
+rvm:
+  - 2.1.0
+gemfile:
+  - Gemfile
+
+notifications:
+  email:
+    recipients:
+      - sky4winder+githubchangeloggenerator@gmail.com
+    on_success: never # [always|never|change]
+    on_failure: change # [always|never|change]

CHANGELOG.md

@@ -1,12 +1,62 @@
 # Changelog
 
+## [1.2.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.4)
+#### 16/12/14
+- *Merged pull-request:* Fix crash when user is NULL [\#40](https://github.com/skywinder/Github-Changelog-Generator/pull/40) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Implement async fetching [\#39](https://github.com/skywinder/Github-Changelog-Generator/pull/39) ([skywinder](https://github.com/skywinder))
+
+- *Implemented enhancement:* Add ability to run with one parameter instead -u -p [\#38](https://github.com/skywinder/Github-Changelog-Generator/issues/38)
+
+- *Implemented enhancement:* Detailed output [\#33](https://github.com/skywinder/Github-Changelog-Generator/issues/33)
+
+- *Fixed bug:* Docs lacking or basic behavior not as advertised [\#30](https://github.com/skywinder/Github-Changelog-Generator/issues/30)
+
+## [1.2.3] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.3)
+#### 16/12/14
+- *Fixed bug:* Encapsulate \[ \> \* \_ \ \] signs in issues names [\#34](https://github.com/skywinder/Github-Changelog-Generator/issues/34)
+
+## [1.2.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.2)
+#### 10/12/14
+- *Merged pull-request:* Add a Bitdeli Badge to README [\#36](https://github.com/skywinder/Github-Changelog-Generator/pull/36) ([bitdeli-chef](https://github.com/bitdeli-chef))
+
+## [1.2.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.1)
+#### 22/11/14
+- *Merged pull-request:* Issues for last tag not in list [\#29](https://github.com/skywinder/Github-Changelog-Generator/pull/29) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Disable default --filter-pull-requests option. [\#28](https://github.com/skywinder/Github-Changelog-Generator/pull/28) ([skywinder](https://github.com/skywinder))
+
+## [1.2.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.2.0)
+#### 19/11/14
+- *Merged pull-request:* Add filter for pull-requests labels. \(option --filter-pull-requests\) [\#27](https://github.com/skywinder/Github-Changelog-Generator/pull/27) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Test Pull-Request SHOULD NOT APPEAR IN LOG! [\#26](https://github.com/skywinder/Github-Changelog-Generator/pull/26) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Add ability to insert authors of pull-requests \(--\[no-\]author option\) [\#25](https://github.com/skywinder/Github-Changelog-Generator/pull/25) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Don't receive issues in case of --no-isses flag specied [\#24](https://github.com/skywinder/Github-Changelog-Generator/pull/24) ([skywinder](https://github.com/skywinder))
+
+## [1.1.4] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.4)
+#### 18/11/14
+- *Merged pull-request:* Sort tags by date [\#23](https://github.com/skywinder/Github-Changelog-Generator/pull/23) ([skywinder](https://github.com/skywinder))
+
+- *Implemented enhancement:* Implement ability to retrieve GitHub token from ENV variable \(to not put it to script directly\) [\#19](https://github.com/skywinder/Github-Changelog-Generator/issues/19)
+
+- *Fixed bug:* Script fills changelog only for first 30 tags. [\#20](https://github.com/skywinder/Github-Changelog-Generator/issues/20)
+
+## [1.1.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.2)
+#### 12/11/14
+- *Merged pull-request:* Fix bug with dot signs in project name [\#18](https://github.com/skywinder/Github-Changelog-Generator/pull/18) ([skywinder](https://github.com/skywinder))
+
+- *Merged pull-request:* Fix bug with dot signs in user name [\#17](https://github.com/skywinder/Github-Changelog-Generator/pull/17) ([skywinder](https://github.com/skywinder))
+
 ## [1.1.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.1)
 #### 10/11/14
-- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15)
+- *Merged pull-request:* Remove duplicates of issues and pull-requests with same number [\#15](https://github.com/skywinder/Github-Changelog-Generator/pull/15) ([skywinder](https://github.com/skywinder))
 
-- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14)
+- *Merged pull-request:* Sort issues by tags [\#14](https://github.com/skywinder/Github-Changelog-Generator/pull/14) ([skywinder](https://github.com/skywinder))
 
-- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13)
+- *Merged pull-request:* Add ability to add or exclude issues without any labels [\#13](https://github.com/skywinder/Github-Changelog-Generator/pull/13) ([skywinder](https://github.com/skywinder))
 
 ## [1.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.1.0)
 #### 10/11/14
@@ -18,13 +68,13 @@
 
 ## [1.0.1] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.1)
 #### 10/11/14
-- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8)
+- *Merged pull-request:* Implement support of different tags. [\#8](https://github.com/skywinder/Github-Changelog-Generator/pull/8) ([skywinder](https://github.com/skywinder))
 
 ## [1.0.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/1.0.0)
 #### 07/11/14
-- *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7)
+- *Merged pull-request:* Add support for issues in CHANGELOG [\#7](https://github.com/skywinder/Github-Changelog-Generator/pull/7) ([skywinder](https://github.com/skywinder))
 
-- *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3)
+- *Merged pull-request:* Fix parsing date of pull request [\#3](https://github.com/skywinder/Github-Changelog-Generator/pull/3) ([skywinder](https://github.com/skywinder))
 
 - *Implemented enhancement:* Implement option to specify output filename [\#4](https://github.com/skywinder/Github-Changelog-Generator/issues/4)
 
@@ -34,9 +84,9 @@
 
 ## [0.1.0] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.1.0)
 #### 07/11/14
-- *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2)
+- *Merged pull-request:* Add changelog generation for last tag [\#2](https://github.com/skywinder/Github-Changelog-Generator/pull/2) ([skywinder](https://github.com/skywinder))
 
-- *Merged pull-request:* Add option (-o --output) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1)
+- *Merged pull-request:* Add option \(-o --output\) to specify name of the output file. [\#1](https://github.com/skywinder/Github-Changelog-Generator/pull/1) ([skywinder](https://github.com/skywinder))
 
 ## [0.0.2] (https://github.com/skywinder/Github-Changelog-Generator/tree/0.0.2)
 #### 06/11/14

Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 gem 'github_api'
-gem 'httparty'
+gem 'colorize'
+gem 'rake'

Gemfile.lock

@@ -2,6 +2,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.6)
+    colorize (0.7.4)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     faraday (0.9.0)
@@ -14,17 +15,13 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
-    hashie (3.3.1)
-    httparty (0.13.2)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.1)
-    jwt (1.0.0)
+    hashie (3.3.2)
+    jwt (1.2.0)
     mini_portile (0.6.1)
     multi_json (1.10.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.4)
+    nokogiri (1.6.5)
       mini_portile (~> 0.6.0)
     oauth2 (1.0.0)
       faraday (>= 0.8, < 0.10)
@@ -33,11 +30,13 @@ GEM
       multi_xml (~> 0.5)
       rack (~> 1.2)
     rack (1.5.2)
+    rake (10.4.2)
     thread_safe (0.3.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  colorize
   github_api
-  httparty
+  rake

README.md

@@ -2,63 +2,84 @@ GitHub Changelog Generator
 ==================
 
 [![Gem Version](https://badge.fury.io/rb/github_changelog_generator.svg)](http://badge.fury.io/rb/github_changelog_generator)
+[![Build Status](https://travis-ci.org/skywinder/Github-Changelog-Generator.svg?branch=master)](https://travis-ci.org/skywinder/Github-Changelog-Generator)
 
 Changelog generation has never been so easy.
 
 This script automatically generate change-log from your tags and merged pull-requests.
 
 ## Installation:
+You're almost done!
+
 	[sudo] gem install github_changelog_generator
 
 ## Usage
 **It's really simple**: 
 
-- `cd` to your Project folder with configured git and just type:
+- If your **git remote** `origin` refer to your GitHub repo, then just go to your project folder  just run:
 
 		github_changelog_generator
 
-- from anywhere:
+-  or from anywhere:
 
 		github_changelog_generator -u github-username -p github-project
      
 As output you will get `CHANGELOG.md` file with *pretty Markdown-formatted* changelog.
 
-## Params:
+### Params:
 Type `github_changelog_generator --help` for detailed usage.
 
     Usage: changelog_generator [options]
-    -u, --user [USER]                Username of the owner of target GitHub repo
-    -p, --project [PROJECT]          Name of project on GitHub
-    -t, --token [TOKEN]              To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications
-    -h, --help                       Displays Help
-    -v, --[no-]verbose               Run verbosely. Default is true
-        --[no-]issues                Include closed issues to changelog. Default is true
-        --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
-        --[no-]pull-requests         Include pull-requests to changelog. Default is true
-    -l, --last-changes               Generate log between last 2 tags only
-    -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
-    -o, --output [NAME]              Output file. Default is CHANGELOG.md
-        --labels  x,y,z              List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
-
-## Examples:
-
-- Look at changelog for **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for this project
-- This changelog: [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
-
-		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+        -u, --user [USER]                Username of the owner of target GitHub repo
+        -p, --project [PROJECT]          Name of project on GitHub
+        -t, --token [TOKEN]              To make more than 50 requests this script required your OAuth token for GitHub. You can generate here: https://github.com/settings/tokens/new
+        -h, --help                       Displays Help
+            --[no-]verbose               Run verbosely. Default is true
+            --[no-]issues                Include closed issues to changelog. Default is true
+            --[no-]issues-without-labels Include closed issues without any labels to changelog. Default is true
+            --[no-]pull-requests         Include pull-requests to changelog. Default is true
+        -l, --last-changes               Generate log between last 2 tags only
+            --[no-]author                Add author of pull-request in the end. Default is true
+        -f, --date-format [FORMAT]       Date format. Default is %d/%m/%y
+        -o, --output [NAME]              Output file. Default is CHANGELOG.md
+            --labels  x,y,z              List of labels. Issues with that labels will be included to changelog. Default is 'bug,enhancement'
+        -v, --version                    Print version number
 
 
-## FAQ:
-Since GitHub allow to make only 50 requests without authentication it's recommended to run this scrip with key `-t [your-16-digit-token]` that you can easily **[generate it here](https://github.com/settings/applications)**.
+### GitHub token
+
+Since GitHub allow to make only 50 requests without authentication it's recommended to run this script with token
+
+**You can easily [generate it here](https://github.com/settings/applications)**.
+
+And:
+
+- Run with key `-t [your-16-digit-token]` 
+- Or set environment variable `CHANGELOG_GITHUB_TOKEN` and specify there your token. 
+ 		
+	i.e. add to your `~/.bash_profile` or `~/.zshrc` or any other place to load ENV variables string `export CHANGELOG_GITHUB_TOKEN="your-40-digit-github-token"'`
 
 So, if you got error like this:
 >! /Library/Ruby/Gems/2.0.0/gems/github_api-0.12.2/lib/github_api/response/raise_error.rb:14:in `on_complete'
 
 It's time to create this token or wait for 1 hour before GitHub reset the counter for your IP.
 
+## Examples:
+
+- Look at **[CHANGELOG.md](https://github.com/skywinder/Github-Changelog-Generator/blob/master/CHANGELOG.md)** for **this** project
+- [ActionSheetPicker-3.0/CHANGELOG.md](https://github.com/skywinder/ActionSheetPicker-3.0/blob/master/CHANGELOG.md)  was generated by command:
+
+		github_changelog_generator -u skywinder -p ActionSheetPicker-3.0
+
+
+## Projects using this library
+[Wikipage with list of projects](https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) 
+
+*If you are using `github_changelog_generator` for generation chamgelog in your project or know of project that uses it, please add it to [this] (https://github.com/skywinder/Github-Changelog-Generator/wiki/Projects-using-Github-Changelog-Generator) list.*
+
 ## Am I missed some essential feature?
 
-**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's get this generator better together!
+**Nothing is impossible!** Open an [issue](https://github.com/skywinder/Github-Changelog-Generator/issues/new) and let's make generator better together!
 
 *Bug reports, feature requests, patches, well-wishes are always welcome!*
 
@@ -74,3 +95,7 @@ It's time to create this token or wait for 1 hour before GitHub reset the counte
 ## License
 
 Github Changelog Generator is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/skywinder/github-changelog-generator/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+

Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.libs.push("demo", "test")
+  t.pattern = "test/**/*_test.rb"
+end

bin/github_changelog_generator

@@ -1,5 +1,4 @@
-#!/usr/bin/env ruby
+#! /usr/bin/env ruby
 
 require 'github_changelog_generator'
-
-ChangelogGenerator.new.compund_changelog
+GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog

github_changelog_generator.gemspec

@@ -1,21 +1,32 @@
-Gem::Specification.new do |s|
-  s.name               = "github_changelog_generator"
-  s.version            = "1.1.2"
-  s.default_executable = "github_changelog_generator"
+# coding: utf-8
 
-  s.required_ruby_version     = '>= 1.9.3'
-  s.authors = ["Petr Korolev"]
-  s.date = %q{2014-10-10}
-  s.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
-  s.email = %q{sky4winder+github_changelog_generator@gmail.com}
-  s.files = ["lib/github_changelog_generator.rb", "lib/github_changelog_generator/parser.rb", "bin/github_changelog_generator"]
-  s.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
-  s.license       = "MIT"
-  s.add_runtime_dependency(%q<httparty>, ["~> 0.13"])
-  s.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_changelog_generator/version'
+
+Gem::Specification.new do |spec|
+  spec.name               = "github_changelog_generator"
+  spec.version            = GitHubChangelogGenerator::VERSION
+  spec.default_executable = "github_changelog_generator"
+
+  spec.required_ruby_version     = '>= 1.9.3'
+  spec.authors = ["Petr Korolev"]
+  spec.email = %q{sky4winder+github_changelog_generator@gmail.com}
+  spec.date = `date +"%Y-%m-%d"`.strip!
+  spec.summary = %q{Script, that automatically generate change-log from your tags and pull-requests.}
+  spec.description = %q{Script, that automatically generate change-log from your tags and pull-requests}
+  spec.homepage = %q{https://github.com/skywinder/Github-Changelog-Generator}
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency(%q<github_api>, ["~> 0.12"])
+  spec.add_runtime_dependency(%q<colorize>, ["~> 0.7"])
 
-  s.executables   = %w(github_changelog_generator)
 end

lib/github_changelog_generator.rb

@@ -2,329 +2,458 @@
 
 require 'github_api'
 require 'json'
-require 'httparty'
+require 'colorize'
+require 'benchmark'
+
 require_relative 'github_changelog_generator/parser'
+require_relative 'github_changelog_generator/generator'
+require_relative 'github_changelog_generator/version'
 
+module GitHubChangelogGenerator
+  class ChangelogGenerator
 
-class ChangelogGenerator
+    attr_accessor :options, :all_tags, :github
 
-  attr_accessor :options, :all_tags, :github
+    PER_PAGE_NUMBER = 30
 
-  def initialize()
+    def initialize
 
-    @options = Parser.parse_options
-    if @options[:token]
-      @github = Github.new oauth_token: @options[:token]
-    else
-      @github = Github.new
-    end
-    @all_tags = self.get_all_tags
-    @pull_requests = self.get_all_closed_pull_requests
-    @issues = self.get_all_issues
+      @options = Parser.parse_options
 
-    @tag_times_hash = {}
-  end
+      if options[:verbose]
+        puts 'Input options:'
+        pp options
+        puts ''
+      end
 
-  def print_json(json)
-    puts JSON.pretty_generate(json)
-  end
+      github_token
 
-  def exec_command(cmd)
-    exec_cmd = "cd #{$project_path} && #{cmd}"
-    %x[#{exec_cmd}]
-  end
+      github_options = {per_page: PER_PAGE_NUMBER}
+      github_options[:oauth_token] = @github_token unless @github_token.nil?
+      github_options[:endpoint] = options[:github_endpoint] unless options[:github_endpoint].nil?
+      github_options[:site] = options[:github_endpoint] unless options[:github_site].nil?
 
+      @github = Github.new github_options
 
-  def get_all_closed_pull_requests
-    request = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
-    pull_requests = request.body
+      @generator = Generator.new(@options)
 
-    if @options[:verbose]
-      puts 'Receive all pull requests'
+      @all_tags = self.get_all_tags
+      @pull_requests = self.get_all_closed_pull_requests
+      if @options[:issues]
+        @issues = self.get_all_issues
+      else
+        @issues = []
+      end
+
+      @tag_times_hash = {}
     end
 
-    pull_requests
-  end
-
-  def compund_changelog
-    if @options[:verbose]
-      puts 'Generating changelog:'
+    def print_json(json)
+      puts JSON.pretty_generate(json)
     end
 
-    log = "# Changelog\n\n"
+    def exec_command(cmd)
+      exec_cmd = "cd #{$project_path} and #{cmd}"
+      %x[#{exec_cmd}]
+    end
 
-    if @options[:last]
-      log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
-    elsif @options[:tag1] && @options[:tag2]
 
-      tag1 = @options[:tag1]
-      tag2 = @options[:tag2]
-      tags_strings = []
-      self.all_tags.each { |x| tags_strings.push(x['name']) }
+    def get_all_closed_pull_requests
 
-      if tags_strings.include?(tag1)
-        if tags_strings.include?(tag2)
-          hash = Hash[tags_strings.map.with_index.to_a]
-          index1 = hash[tag1]
-          index2 = hash[tag2]
-          log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
+      if @options[:verbose]
+        print "Fetching pull requests...\r"
+      end
+
+      response = @github.pull_requests.list @options[:user], @options[:project], :state => 'closed'
+
+      pull_requests = []
+      page_i = 0
+      response.each_page do |page|
+        page_i += PER_PAGE_NUMBER
+        print "Fetching pull requests... #{page_i}\r"
+        pull_requests.concat(page)
+      end
+
+      print "\r"
+
+      if @options[:verbose]
+        puts "Received closed pull requests: #{pull_requests.count}"
+      end
+
+      unless @options[:pull_request_labels].nil?
+
+        if @options[:verbose]
+          puts 'Filter all pull requests by labels.'
+        end
+
+        filtered_pull_requests = pull_requests.select { |pull_request|
+          #We need issue to fetch labels
+          issue = @github.issues.get @options[:user], @options[:project], pull_request.number
+          #compare is there any labels from @options[:labels] array
+          select_no_label = !issue.labels.map { |label| label.name }.any?
+
+          if @options[:verbose]
+            puts "Filter request \##{issue.number}."
+          end
+
+          if @options[:pull_request_labels].any?
+            select_by_label = (issue.labels.map { |label| label.name } & @options[:pull_request_labels]).any?
+          else
+            select_by_label = false
+          end
+
+          select_by_label | select_no_label
+        }
+
+        if @options[:verbose]
+          puts "Filtered pull requests with specified labels and w/o labels: #{filtered_pull_requests.count}"
+        end
+        return filtered_pull_requests
+      end
+
+      pull_requests
+    end
+
+    def compund_changelog
+      if @options[:verbose]
+        puts 'Generating changelog:'
+      end
+
+      log = "# Changelog\n\n"
+
+      if @options[:last]
+        log += self.generate_log_between_tags(self.all_tags[0], self.all_tags[1])
+      elsif @options[:tag1] and @options[:tag2]
+        tag1 = @options[:tag1]
+        tag2 = @options[:tag2]
+        tags_strings = []
+        self.all_tags.each { |x| tags_strings.push(x['name']) }
+
+        if tags_strings.include?(tag1)
+          if tags_strings.include?(tag2)
+            hash = Hash[tags_strings.map.with_index.to_a]
+            index1 = hash[tag1]
+            index2 = hash[tag2]
+            log += self.generate_log_between_tags(self.all_tags[index1], self.all_tags[index2])
+          else
+            puts "Can't find tag #{tag2} -> exit"
+            exit
+          end
         else
-          puts "Can't find tag #{tag2} -> exit"
+          puts "Can't find tag #{tag1} -> exit"
           exit
         end
       else
-        puts "Can't find tag #{tag1} -> exit"
-        exit
+        log += self.generate_log_for_all_tags
       end
-    else
-      log += self.generate_log_for_all_tags
+
+      log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
+
+      output_filename = "#{@options[:output]}"
+      File.open(output_filename, 'w') { |file| file.write(log) }
+
+      puts "Done! Generated log placed in #{`pwd`.strip!}/#{output_filename}"
+
     end
 
-    log += "\n\n\\* *This changelog was generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*"
+    def generate_log_for_all_tags
+      log = ''
 
-    output_filename = "#{@options[:output]}"
-    File.open(output_filename, 'w') { |file| file.write(log) }
+      # Async fetching tags:
+      threads = []
+      @all_tags.each { |tag|
+        threads << Thread.new { self.get_time_of_tag(tag) }
+      }
+      threads.each { |thr| thr.join }
 
-    puts "Done! Generated log placed in #{output_filename}"
+      if @options[:verbose]
+        puts "Sorting tags.."
+      end
 
-  end
+      @all_tags.sort_by! { |x| self.get_time_of_tag(x) }.reverse!
 
-  def generate_log_for_all_tags
-    log = ''
-    for index in 1 ... self.all_tags.size
-      log += self.generate_log_between_tags(self.all_tags[index-1], self.all_tags[index])
+      if @options[:verbose]
+        puts "Generating log.."
+      end
+
+      (1 ... self.all_tags.size).each { |index|
+        log += self.generate_log_between_tags(self.all_tags[index], self.all_tags[index-1])
+      }
+
+      log += generate_log_between_tags(nil, self.all_tags.last)
+
+      log
     end
 
-    log += self.generate_log_before_tag(self.all_tags.last)
-
-    log
-  end
-
-  def is_megred(number)
-    @github.pull_requests.merged? @options[:user], @options[:project], number
-  end
-
-  def get_all_tags
-
-    url = "https://api.github.com/repos/#{@options[:user]}/#{@options[:project]}/tags"
-
-    if @options[:verbose]
-      puts "Receive tags for repo #{url}"
+    def is_megred(number)
+      @github.pull_requests.merged? @options[:user], @options[:project], number
     end
 
-    if @options[:token]
-      response = HTTParty.get(url,
-                              :headers => {'Authorization' => "token #{@options[:token]}",
-                                           'User-Agent' => 'Changelog-Generator'})
-    else
-      response = HTTParty.get(url,
-                              :headers => {'User-Agent' => 'Changelog-Generator'})
+    def get_all_tags
+
+      if @options[:verbose]
+        print "Fetching tags...\r"
+      end
+
+      response = @github.repos.tags @options[:user], @options[:project]
+
+      tags = []
+      page_i = 0
+      response.each_page do |page|
+        page_i += PER_PAGE_NUMBER
+        print "Fetching tags... #{page_i}\r"
+        tags.concat(page)
+      end
+      print "\r"
+      if @options[:verbose]
+        puts "Found #{tags.count} tags"
+      end
+
+      tags
     end
 
-    json_parse = JSON.parse(response.body)
+    def github_token
+      if @options[:token]
+        return @github_token ||= @options[:token]
+      end
+
+      env_var = ENV.fetch 'CHANGELOG_GITHUB_TOKEN', nil
+
+      unless env_var
+        puts "Warning: No token provided (-t option) and variable $CHANGELOG_GITHUB_TOKEN was not found.".yellow
+        puts "This script can make only 50 requests to GitHub API per hour without token!".yellow
+      end
+
+      @github_token ||= env_var
 
-    if @options[:verbose]
-      puts "Found #{json_parse.count} tags"
     end
 
-    json_parse
-  end
 
-  def generate_log_between_tags(since_tag, till_tag)
-    since_tag_time = self.get_time_of_tag(since_tag)
-    till_tag_time = self.get_time_of_tag(till_tag)
+    def generate_log_between_tags(older_tag, newer_tag)
 
-    # if we mix up tags order - lits fix it!
-    if since_tag_time > till_tag_time
-      since_tag, till_tag = till_tag, since_tag
-      since_tag_time, till_tag_time = till_tag_time, since_tag_time
-    end
+      if newer_tag.nil?
+        puts "Can't find tag -> terminate"
+        exit 1
+      end
 
-    till_tag_name = till_tag['name']
+      newer_tag_time = self.get_time_of_tag(newer_tag)
+      newer_tag_name = newer_tag['name']
 
-    pull_requests = Array.new(@pull_requests)
-
-    pull_requests.delete_if { |req|
-      if req[:merged_at]
-        t = Time.parse(req[:merged_at]).utc
-        tag_is_later_since = t > since_tag_time
-        tag_is_before_till = t <= till_tag_time
-
-        in_range = (tag_is_later_since) && (tag_is_before_till)
-        !in_range
+      if older_tag.nil?
+        filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time)
+        filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time)
       else
-        true
+        older_tag_time = self.get_time_of_tag(older_tag)
+        filtered_pull_requests = delete_by_time(@pull_requests, :merged_at, newer_tag_time, older_tag_time)
+        filtered_issues = delete_by_time(@issues, :closed_at, newer_tag_time, older_tag_time)
       end
 
-    }
 
-    issues = Array.new(@issues)
+      if @options[:filter_issues_by_milestone]
+        #delete excess irrelevant issues (according milestones)
+        filtered_issues.select! { |issue|
+          if issue.milestone.nil?
+            true
+          else
+            #check, that this milestone in tag list:
+            milestone_is_tag = @all_tags.find { |tag|
+              tag.name == issue.milestone.title
+            }
+            milestone_is_tag.nil?
+          end
 
-    issues.delete_if { |issue|
-      if issue[:closed_at]
-        t = Time.parse(issue[:closed_at]).utc
-        tag_is_later_since = t > since_tag_time
-        tag_is_before_till = t <= till_tag_time
+        }
 
-        in_range = (tag_is_later_since) && (tag_is_before_till)
-        !in_range
-      else
-        true
+        #add missed issues (according milestones)
+        issues_to_add = @issues.select { |issue|
+          if issue.milestone.nil?
+            false
+          else
+            #check, that this milestone in tag list:
+            milestone_is_tag = @all_tags.find { |tag|
+              tag.name == issue.milestone.title
+            }
+
+            if milestone_is_tag.nil?
+              false
+            else
+              issue.milestone.title == newer_tag_name
+            end
+          end
+        }
+
+        filtered_issues |= issues_to_add
       end
 
-    }
+      self.create_log(filtered_pull_requests, filtered_issues, newer_tag_name, newer_tag_time)
 
-    self.create_log(pull_requests, issues, till_tag_name, till_tag_time)
+    end
 
-  end
+    def delete_by_time(array, hash_key, newer_tag_time, older_tag_time = nil)
+      array.select { |req|
+        if req[hash_key]
+          t = Time.parse(req[hash_key]).utc
 
-  def generate_log_before_tag(tag)
-    tag_time = self.get_time_of_tag(tag)
-    tag_name = tag['name']
+          if older_tag_time.nil?
+            tag_in_range_old = true
+          else
+            tag_in_range_old = t > older_tag_time
+          end
 
-    pull_requests = Array.new(@pull_requests)
+          tag_in_range_new = t <= newer_tag_time
 
-    pull_requests.delete_if { |req|
-      if req[:merged_at]
-        t = Time.parse(req[:merged_at]).utc
-        t > tag_time
-      else
-        true
+          tag_in_range = (tag_in_range_old) && (tag_in_range_new)
+
+          tag_in_range
+        else
+          false
+        end
+      }
+    end
+
+# @param [Array] pull_requests
+# @param [Array] issues
+# @param [String] tag_name
+# @param [String] tag_time
+# @return [String]
+    def create_log(pull_requests, issues, tag_name, tag_time)
+
+      github_site = options[:github_site] || 'https://github.com'
+
+      # Generate tag name and link
+      log = "## [#{tag_name}] (#{github_site}/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
+
+      #Generate date string:
+      time_string = tag_time.strftime @options[:format]
+      log += "#### #{time_string}\n"
+
+      if @options[:pulls]
+        # Generate pull requests:
+        pull_requests.each { |pull_request|
+          merge = @generator.get_string_for_pull_request(pull_request)
+          log += "- #{merge}"
+
+        } if pull_requests
       end
 
-    }
+      if @options[:issues]
+        # Generate issues:
+        if issues
+          issues.sort! { |x, y|
+            if x.labels.any? && y.labels.any?
+              x.labels[0].name <=> y.labels[0].name
+            else
+              if x.labels.any?
+                1
+              else
+                if y.labels.any?
+                  -1
+                else
+                  0
+                end
+              end
+            end
+          }.reverse!
+        end
+        issues.each { |dict|
+          is_bug = false
+          is_enhancement = false
+          dict.labels.each { |label|
+            if label.name == 'bug'
+              is_bug = true
+            end
+            if label.name == 'enhancement'
+              is_enhancement = true
+            end
+          }
 
-    issues = Array.new(@issues)
+          intro = 'Closed issue'
+          if is_bug
+            intro = 'Fixed bug'
+          end
 
-    issues.delete_if { |issue|
-      if issue[:closed_at]
-        t = Time.parse(issue[:closed_at]).utc
-        t > tag_time
-      else
-        true
-      end
-    }
+          if is_enhancement
+            intro = 'Implemented enhancement'
+          end
 
-    self.create_log(pull_requests, issues, tag_name, tag_time)
+          enc_string = @generator.encapsulate_string dict[:title]
 
-  end
-
-  def create_log(pull_requests, issues, tag_name, tag_time)
-
-    # Generate tag name and link
-    trimmed_tag = tag_name.tr('v', '')
-    log = "## [#{trimmed_tag}] (https://github.com/#{@options[:user]}/#{@options[:project]}/tree/#{tag_name})\n"
-
-    #Generate date string:
-    time_string = tag_time.strftime @options[:format]
-    log += "#### #{time_string}\n"
-
-    if @options[:pulls]
-      # Generate pull requests:
-      if pull_requests
-        pull_requests.each { |dict|
-          merge = "#{@options[:merge_prefix]}#{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
+          merge = "*#{intro}:* #{enc_string} [\\##{dict[:number]}](#{dict.html_url})\n\n"
           log += "- #{merge}"
         }
       end
+      log
     end
 
-    if @options[:issues]
-      # Generate issues:
-      if issues
-        issues.sort! { |x, y|
-          if x.labels.any? && y.labels.any?
-            x.labels[0].name <=> y.labels[0].name
-          else
-            if x.labels.any?
-              1
-            else
-              if y.labels.any?
-                -1
-              else
-                0
-              end
-            end
-          end
-        }.reverse!
+    def get_time_of_tag(prev_tag)
+
+      if @tag_times_hash[prev_tag['name']]
+        return @tag_times_hash[prev_tag['name']]
       end
-      issues.each { |dict|
-        is_bug = false
-        is_enhancement = false
-        dict.labels.each { |label|
-          if label.name == 'bug'
-            is_bug = true
-          end
-          if label.name == 'enhancement'
-            is_enhancement = true
-          end
+
+      github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
+      time_string = github_git_data_commits_get['committer']['date']
+      Time.parse(time_string)
+      @tag_times_hash[prev_tag['name']] = Time.parse(time_string)
+    end
+
+    def get_all_issues
+
+      if @options[:verbose]
+        print "Fetching closed issues...\r"
+      end
+
+      response = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
+
+      issues = []
+      page_i = 0
+      response.each_page do |page|
+        page_i += PER_PAGE_NUMBER
+        print "Fetching closed issues... #{page_i}\r"
+        issues.concat(page)
+      end
+
+      print "\r"
+
+      # remove pull request from issues:
+      issues.select! { |x|
+        x.pull_request == nil
+      }
+
+      if @options[:verbose]
+        puts "Received closed issues: #{issues.count}"
+      end
+
+
+      if @options[:verbose]
+        puts "Filtering issues with labels #{@options[:labels]}#{@options[:add_issues_wo_labels] ? ' and w/o labels' : ''}"
+      end
+
+      filtered_issues = issues.select { |issue|
+        #compare is there any labels from @options[:labels] array
+        (issue.labels.map { |label| label.name } & @options[:labels]).any?
+      }
+
+      if @options[:add_issues_wo_labels]
+        issues_wo_labels = issues.select {
+          # add issues without any labels
+            |issue| !issue.labels.map { |label| label.name }.any?
         }
+        filtered_issues.concat(issues_wo_labels)
+      end
 
-        intro = 'Closed issue'
-        if is_bug
-          intro = 'Fixed bug'
-        end
+      if @options[:verbose]
+        puts "Filtered issues: #{filtered_issues.count}"
+      end
 
-        if is_enhancement
-          intro = 'Implemented enhancement'
-        end
+      filtered_issues
 
-        merge = "*#{intro}:* #{dict[:title]} [\\##{dict[:number]}](#{dict.html_url})\n\n"
-        log += "- #{merge}"
-      }
     end
-    log
-  end
-
-  def get_time_of_tag(prev_tag)
-
-    if @tag_times_hash[prev_tag['name']]
-      return @tag_times_hash[prev_tag['name']]
-    end
-
-    if @options[:verbose]
-      puts "Get time for tag #{prev_tag['name']}"
-    end
-
-    github_git_data_commits_get = @github.git_data.commits.get @options[:user], @options[:project], prev_tag['commit']['sha']
-    time_string = github_git_data_commits_get['committer']['date']
-    Time.parse(time_string)
-    @tag_times_hash[prev_tag['name']] = Time.parse(time_string)
-  end
-
-  def get_all_issues
-    all_issues = []
-
-    issues_req = @github.issues.list user: @options[:user], repo: @options[:project], state: 'closed', filter: 'all', labels: nil
-
-    filtered_issues = issues_req.body.select { |issues|
-      #compare is there any labels from @options[:labels] array
-      (issues.labels.map { |issue| issue.name } & @options[:labels]).any?
-    }
-
-    if @options[:add_issues_wo_labels]
-      issues_wo_labels = issues_req.body.select {
-          |issues| !issues.labels.map { |issue| issue.name }.any?
-      }
-      filtered_issues.concat(issues_wo_labels)
-    end
-
-  # remove pull request from issues:
-    filtered_issues.select! { |x|
-      x.pull_request == nil
-    }
-
-    if @options[:verbose]
-      puts "Receive all closed issues with labels #{@options[:labels]}: #{all_issues.count} issues"
-    end
-
-    filtered_issues
 
   end
 
-end
+  if __FILE__ == $0
+    GitHubChangelogGenerator::ChangelogGenerator.new.compund_changelog
+  end
 
-if __FILE__ == $0
-  changelog_generator = ChangelogGenerator.new
-  changelog_generator.compund_changelog
-end
+end

lib/github_changelog_generator/generator.rb

@@ -0,0 +1,38 @@
+module GitHubChangelogGenerator
+  class Generator
+
+    def initialize(options = nil)
+      @options = options
+    end
+
+    def get_string_for_pull_request(pull_request)
+      encapsulated_title = self.encapsulate_string pull_request[:title]
+
+      merge = "#{@options[:merge_prefix]}#{encapsulated_title} [\\##{pull_request[:number]}](#{pull_request.html_url})"
+      if @options[:author]
+        if pull_request.user.nil?
+          merge += " ({Null user})\n\n"
+        else
+          merge += " ([#{pull_request.user.login}](#{pull_request.user.html_url}))\n\n"
+        end
+      else
+        merge += "\n\n"
+      end
+      merge
+    end
+
+    def encapsulate_string(string)
+
+      string.gsub! '\\', '\\\\'
+
+      encpas_chars = %w(> * _ \( \) [ ])
+      encpas_chars.each{ |char|
+        string.gsub! char, "\\#{char}"
+      }
+
+      string
+    end
+
+  end
+
+end

lib/github_changelog_generator/parser.rb

@@ -1,81 +1,107 @@
 #!/usr/bin/env ruby
 require 'optparse'
+require 'pp'
+require_relative 'version'
 
-class Parser
-  def self.parse_options
-    options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ' }
+module GitHubChangelogGenerator
+  class Parser
+    def self.parse_options
+      options = {:tag1 => nil, :tag2 => nil, :format => '%d/%m/%y', :output => 'CHANGELOG.md', :labels => %w(bug enhancement), :pulls => true, :issues => true, :verbose => true, :add_issues_wo_labels => true, :merge_prefix => '*Merged pull-request:* ', :author => true, :pull_request_labels => nil, :filter_issues_by_milestone => true}
 
-    parser = OptionParser.new { |opts|
-      opts.banner = 'Usage: changelog_generator [options]'
-      opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
-        options[:user] = last
+      parser = OptionParser.new { |opts|
+        opts.banner = 'Usage: changelog_generator [options]'
+        opts.on('-u', '--user [USER]', 'Username of the owner of target GitHub repo') do |last|
+          options[:user] = last
+        end
+        opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
+          options[:project] = last
+        end
+        opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests per hour your GitHub token required. You can generate it here: https://github.com/settings/tokens/new') do |last|
+          options[:token] = last
+        end
+        opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
+          options[:format] = last
+        end
+        opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
+          options[:output] = last
+        end
+        opts.on('--[no-]verbose', 'Run verbosely. Default is true') do |v|
+          options[:verbose] = v
+        end
+        opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
+          options[:issues] = v
+        end
+        opts.on('--[no-]issues-without-labels', 'Include closed issues without any labels to changelog. Default is true') do |v|
+          options[:add_issues_wo_labels] = v
+        end
+        opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
+          options[:pulls] = v
+        end
+        opts.on('--[no-]filter-issues-by-milestone', 'Use milestone to detect when issue was resolved. Default is true') do |last|
+          options[:filter_issues_by_milestone] = last
+        end
+        opts.on('--[no-]author', 'Add author of pull-request in the end. Default is true') do |author|
+          options[:last] = author
+        end
+        opts.on('--labels  x,y,z', Array, 'Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
+          options[:labels] = list
+        end
+        opts.on('--labels-pr x,y,z', Array, 'Only pull requests with specified labels will be included to changelog. Default is nil') do |list|
+          options[:pull_request_labels] = list
+        end
+        opts.on('--github-site [URL]', 'The Enterprise Github site on which your project is hosted.') do |last|
+          options[:github_site] = last
+        end
+        opts.on('--github-api [URL]', 'The enterprise endpoint to use for your Github API.') do |last|
+          options[:github_endpoint] = last
+        end
+        opts.on('-v', '--version', 'Print version number') do |v|
+          puts "Version: #{GitHubChangelogGenerator::VERSION}"
+          exit
+        end
+        opts.on('-h', '--help', 'Displays Help') do
+          puts opts
+          exit
+        end
+      }
+
+      parser.parse!
+
+      if ARGV[0] && !ARGV[1]
+        github_site = options[:github_site] ? options[:github_site] : 'github.com'
+        # this match should parse https://github.com/skywinder/Github-Changelog-Generator and skywinder/Github-Changelog-Generator to user and name
+        match = /(?:.+#{Regexp.escape(github_site)}\/)?(.+)\/(.+)/.match(ARGV[0])
+
+        if match[2].nil?
+          exit
+        else
+          options[:user] = match[1]
+          options[:project]= match[2]
+        end
       end
-      opts.on('-p', '--project [PROJECT]', 'Name of project on GitHub') do |last|
-        options[:project] = last
+
+      if !options[:user] && !options[:project]
+        remote = `git remote -vv`.split("\n")
+        match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)?(?:\.git).*/.match(remote[0])
+
+        if match && match[1] && match[2]
+          puts "Detected user:#{match[1]}, project:#{match[2]}"
+          options[:user], options[:project] = match[1], match[2]
+        end
       end
-      opts.on('-t', '--token [TOKEN]', 'To make more than 50 requests this script required your OAuth token for GitHub. You can generate it on https://github.com/settings/applications') do |last|
-        options[:token] = last
-      end
-      opts.on('-h', '--help', 'Displays Help') do
-        puts opts
+
+
+      if !options[:user] || !options[:project]
+        puts parser.banner
         exit
       end
-      opts.on('-v', '--[no-]verbose', 'Run verbosely. Default is true') do |v|
-        options[:verbose] = v
-      end
-      opts.on('--[no-]issues', 'Include closed issues to changelog. Default is true') do |v|
-        options[:issues] = v
-      end
-      opts.on('--[no-]issues-without-labels', 'Include closed issues without any labels to changelog. Default is true') do |v|
-        options[:add_issues_wo_labels] = v
-      end
-      opts.on('--[no-]pull-requests', 'Include pull-requests to changelog. Default is true') do |v|
-        options[:pulls] = v
-      end
-      opts.on('-l', '--last-changes', 'Generate log between last 2 tags only') do |last|
-        options[:last] = last
-      end
-      opts.on('-f', '--date-format [FORMAT]', 'Date format. Default is %d/%m/%y') do |last|
-        options[:format] = last
-      end
-      opts.on('-o', '--output [NAME]', 'Output file. Default is CHANGELOG.md') do |last|
-        options[:output] = last
-      end
-      opts.on('--labels  x,y,z', Array, 'List of labels. Issues with that labels will be included to changelog. Default is \'bug,enhancement\'') do |list|
-        options[:labels] = list
-      end
-    }
 
-    parser.parse!
+      if ARGV[1]
+        options[:tag1] = ARGV[0]
+        options[:tag2] = ARGV[1]
+      end
 
-    #udefined case with 1 parameter:
-    if ARGV[0] && !ARGV[1]
-      puts parser.banner
-      exit
+      options
     end
-
-    if !options[:user] && !options[:project]
-      remote = `git remote -vv`.split("\n")
-      match = /.*(?:[:\/])((?:-|\w|\.)*)\/((?:-|\w|\.)*)\.git.*/.match(remote[0])
-
-      if match && match[1] && match[2]
-        puts "Detected user:#{match[1]}, project:#{match[2]}"
-        options[:user], options[:project] = match[1], match[2]
-      end
-    end
-
-
-    if !options[:user] || !options[:project]
-      puts parser.banner
-      exit
-    end
-
-    if ARGV[1]
-      options[:tag1] = ARGV[0]
-      options[:tag2] = ARGV[1]
-
-    end
-
-    options
   end
-end
+end

lib/github_changelog_generator/version.rb

@@ -0,0 +1,3 @@
+module GitHubChangelogGenerator
+  VERSION = '1.2.5'
+end