githubstats 1.4.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3c307d3a81b095f9d6770eadfb18993ce55c93cf
-  data.tar.gz: c8ed40abb6f5172280d4beb99b0dc51d1b45cb99
+SHA256:
+  metadata.gz: 63d1760b40fbefddd2aa5c8fba01de7eb8b9d4924ba16c3e6e32030265d1a4a7
+  data.tar.gz: b7c45953695c48422332f089338443e9d622d4c25991676a32e6ed28b9e7402d
 SHA512:
-  metadata.gz: 8c6efa12319ea49fe4b8f979325d76caa829949ed625e39e672440f23bf8112ba22848216c5c94a4557b01f6918c4b1064dfeaefd21f0fd6f26a37cf6759ff38
-  data.tar.gz: 5c04f745c7b7e0f10e46831dcad1b1792863e6cf3c0c08b570dcaae718c38bfbdf96a6e78e67a7bdc15cb26ca7895ebb5857dd0ff3d843160bbca0ac2b4bb72c
+  metadata.gz: ed67ab09a4247ed69c8a12d597010ca7dd1e7f76add17553834d54fa350a3bd93fc402575fdf202ee05bf486ca2c1c386d8f8800daff3b1c8bf17b3704fc6ab5
+  data.tar.gz: 0154bdd9747143f0974313aff0a53b03d8252fab6e104af13ebade18d20057cbd8a62c0057032ccef9e9a60d3a441f66d1521a9cac1bd9efe700b87b3fe014f3

data/.circle-ruby

@@ -1,3 +1,4 @@
-2.4.1
-2.3.4
-2.2.7
+2.6.1
+2.5.3
+2.4.5
+2.3.8

data/.prospectus

@@ -1,25 +1,11 @@
-Prospectus.extra_dep('file', 'prospectus_circleci')
-
 my_slug = 'akerl/githubstats'
 
+Prospectus.extra_dep('file', 'prospectus_travis')
+Prospectus.extra_dep('file', 'prospectus_gems')
+
 item do
   noop
 
-  deps do
-    item do
-      name 'gems'
-
-      expected do
-        static
-        set 'green'
-      end
-
-      actual do
-        gemnasium
-        slug my_slug
-      end
-    end
-  end
-
-  extend ProspectusCircleci::Build.new(my_slug)
+  extend ProspectusGems::Gemspec.new
+  extend ProspectusTravis::Build.new(my_slug)
 end

data/.rubocop.yml

@@ -1,4 +1,5 @@
-Encoding:
-    Enabled: false
+inherit_gem:
+  goodcop: .rubocop.yml
 Metrics/BlockLength:
-    Enabled: false
+  Exclude:
+  - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,10 @@
+dist: xenial
+install:
+- for i in $(cat .circle-ruby) ; do rvm install $i || exit 1 ; done
+- for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done
+script:
+- for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done
+notifications:
+  email: false
+  slack:
+    secure: PQOCIfuacnmF9MMGmZseYwGn8HfxmL1m7qqftoWhDkkp8oKLKVaSfoMPGAADWQsWLBl4JQC+z/lRH8I2gXChQjZhKZBz15bFH6mwFBI82DXidVNVxt27g/uR3RMT8GfGw8CkgW8DsSpNF+E4pBPOKONFLhj9Y0xdpAID7slrPwd6wDdpi4oDXvnfTO4ZfUZbB3OGT0nnzcH4gCiKXKijv4MRzHTVpvbwe+P3TOKkTY0V21B++YSBpX1tIYt6cLOHaDFQT4DScwFajtvynpwWf3PCRMCATganpyEqEpkiUp+dSg1h2WjYilAwVHkLnNaESUFKeTLQGIXpKMj4+3yHlIPPG6M2MawgwhSDuYy1IAE/81+Y06V9Sn9PPnICsjV1+W0LxnCms13t1JcVWrzVOtlzyCInKr8ENAX6Ku6SSQaouuqYghm1maG8ZtNhqyByqGctov7noLUH6T+lHS8ODr22cLg6f0lzVn5d13/aha9OvTZV7DN6uVCfwpbAL9S+u1TNtjrDhJQFohSe7X+jb+KxN7sLZR5Z5RKwM8sx6Tadf3rrvVRF5+jQxpb2IgjakV2QgxmVDrZDu3XXWbRUYMlGbmR4EEwDaKPJsjKh8KIu6GS6rhrQHiwvwDH6FQcXdeQsieLaVTBoKnE1slYvRMVTMZxFkAbI2dIt+H06c7c=

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 3.1.0 / 2020-10-06
+
+* [FEATURE] Remove curb dependency, which allows githubstats to work on Windows systems. Thanks @ajmeese7!
+
+# 3.0.1 / 2018-08-19
+
+* [BUGFIX] Fix cap used to decide when to use real_streak GitHub polling
+
+# 3.0.0 / 2018-07-18
+
+* [BUGFIX] Update to work with recent GitHub changes for historic streak lookup API
+* [FEATURE] Historic GitHub streaks now show actual stats instead of `-1` placeholders
+* [FEATURE] It is now possible to convert a datapoint back to its original format with `.to_a`
+* [FEATURE] Added `.start_date` and `.end_date` to Data object
+
+# 2.0.0 / 2017-09-29
+
+* [BUGFIX] Fail cleanly if Github responds with a bad HTTP code
+
 # 1.4.0 / 2017-06-09
 
 * [ENHANCEMENT] Cache more data methods

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-

data/README.md

@@ -2,10 +2,8 @@ GithubStats
 =========
 
 [![Gem Version](https://img.shields.io/gem/v/githubstats.svg)](https://rubygems.org/gems/githubstats)
-[![Dependency Status](https://img.shields.io/gemnasium/akerl/githubstats.svg)](https://gemnasium.com/akerl/githubstats)
-[![Build Status](https://img.shields.io/circleci/project/akerl/githubstats/master.svg)](https://circleci.com/gh/akerl/githubstats)
+[![Build Status](https://img.shields.io/travis/com/akerl/githubstats.svg)](https://travis-ci.com/akerl/githubstats)
 [![Coverage Status](https://img.shields.io/codecov/c/github/akerl/githubstats.svg)](https://codecov.io/github/akerl/githubstats)
-[![Code Quality](https://img.shields.io/codacy/d25d2521df3f4a6b8369edd419438d97.svg)](https://www.codacy.com/app/akerl/githubstats)
 [![MIT Licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://tldrlegal.com/license/mit-license)
 
 Grabs Github contribution statistics and presents it in an easily consumable format.

data/Rakefile

@@ -7,8 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc 'Run Rubocop on the gem'
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
   task.fail_on_error = true
 end
 
-task default: [:spec, :rubocop, :build, :install]
+task default: %i[spec rubocop build install]

data/githubstats.gemspec

@@ -1,13 +1,14 @@
-$:.unshift File.expand_path('../lib/', __FILE__)
+require 'English'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'githubstats/version'
 
 Gem::Specification.new do |s|
   s.name        = 'githubstats'
   s.version     = GithubStats::VERSION
-  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.date        = Time.now.strftime('%Y-%m-%d')
 
   s.summary     = 'Present Github contributions stats in a consumable format'
-  s.description = "Pulls the statistics from Github's user contribution chart and provides an interface for analyzing that data"
+  s.description = 'Pulls the statistics from Github\'s user contribution chart and provides an interface for analyzing that data' # rubocop:disable Metrics/LineLength
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/githubstats'
@@ -17,14 +18,14 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files spec/*`.split
   s.executables = ['githubstats']
 
-  s.add_runtime_dependency 'curb', '~> 0.9.0'
   s.add_runtime_dependency 'basiccache', '~> 1.0.0'
-  s.add_runtime_dependency 'nokogiri', '~> 1.8.0'
+  s.add_runtime_dependency 'nokogiri', '~> 1.10.8'
 
-  s.add_development_dependency 'timecop', '~> 0.8.0'
-  s.add_development_dependency 'rubocop', '~> 0.49.0'
-  s.add_development_dependency 'rake', '~> 12.0.0'
   s.add_development_dependency 'codecov', '~> 0.1.1'
-  s.add_development_dependency 'rspec', '~> 3.6.0'
-  s.add_development_dependency 'fuubar', '~> 2.2.0'
+  s.add_development_dependency 'fuubar', '~> 2.5.0'
+  s.add_development_dependency 'goodcop', '~> 0.8.0'
+  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'rspec', '~> 3.9.0'
+  s.add_development_dependency 'rubocop', '~> 0.76.0'
+  s.add_development_dependency 'timecop', '~> 0.9.0'
 end

data/lib/githubstats.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'curb'
 require 'json'
 require 'nokogiri'
+require 'net/http'
 require 'date'
 require 'basiccache'
 
@@ -34,14 +34,14 @@ module GithubStats
   ##
   # Default URL for grabbing data
 
-  DEFAULT_URL = "#{DEFAULT_HOST}/users/%s/contributions".freeze
+  DEFAULT_URL = "#{DEFAULT_HOST}/users/%s/contributions"
 
   ##
   # User object
   class User
     include MethodCacher
 
-    attr_reader :name, :url, :data, :last_updated
+    attr_reader :name, :url, :last_updated
 
     ##
     # Creates a new user object
@@ -51,8 +51,7 @@ module GithubStats
       @name = params[:name] || guess_user
       @url = (params[:url] || DEFAULT_URL) % @name
       @last_updated = nil
-      enable_caching %i[streak longest_streak streaks real_streak
-                        real_streak_start]
+      enable_caching %i[streak longest_streak streaks]
     end
 
     ##
@@ -74,7 +73,7 @@ module GithubStats
 
     def streaks
       naive = data.streaks
-      return naive if naive.last.nil? || naive.last.size < 365
+      return naive if naive.last.nil? || naive.last.size < 364
       [real_streak]
     end
 
@@ -82,7 +81,7 @@ module GithubStats
     # Set a custom longest_streak to account for the overriden streak
 
     def longest_streak
-      return data.longest_streak if data.longest_streak.size < 365
+      return data.longest_streak if data.longest_streak.size < 364
       streak
     end
 
@@ -118,40 +117,46 @@ module GithubStats
 
     def load_data
       @data = GithubStats::Data.new download
-      @last_updated = DateTime.now
+      @last_updated = Time.now
     end
 
     ##
-    # Set a custom longest_streak that takes into account GitHub,
-    # which reports full length but only gives data for a year
-
-    def real_streak_start(chart_start)
-      res = GithubStats::Data.new download(chart_start.strftime('%Y-%m-%d'))
-      last_streak_start = res.streaks.last.first.date
-      new_chart_start = res.raw.first.date
-      return last_streak_start unless last_streak_start == new_chart_start
-      real_streak_start(new_chart_start)
+    # Set a custom longest_streak that takes into account GitHub's
+    # historical records
+
+    def real_streak_rewind(partial_streak)
+      new_data = download(partial_streak.first.date - 1)
+      old_data = partial_streak.map(&:to_a)
+      new_stats = GithubStats::Data.new(new_data + old_data)
+      partial_streak = new_stats.streaks.last
+      return partial_streak if partial_streak.first.date != new_stats.start_date
+      real_streak_rewind partial_streak
     end
 
     def real_streak
-      existing = data.streaks.last
-      first_date = existing.first.date
-      extra_size = (first_date - real_streak_start(first_date))
-      [-1] * extra_size + existing
+      @real_streak ||= real_streak_rewind(data.streaks.last)
     end
 
     ##
     # Downloads new data from Github
 
-    def download(from = nil)
-      url = from ? @url + "?from=#{from}" : @url
-      svg = Curl::Easy.perform(url).body_str
-      html = Nokogiri::HTML(svg)
+    def download(to_date = nil)
+      resp = request(to_date)
+      html = Nokogiri::HTML(resp)
       html.css('.day').map do |x|
         x.attributes.values_at('data-date', 'data-count').map(&:value)
       end
-    rescue
-      raise 'Unable to load data from Github'
+    end
+
+    def request(to_date = nil)
+      url = to_date ? @url + "?to=#{to_date.strftime('%Y-%m-%d')}" : @url
+      # https://stackoverflow.com/a/5786863/6456163
+      resp = Net::HTTP.get_response(URI(url))
+      code = resp.code
+      raise("Failed loading data from GitHub: #{url} #{code}") if code != '200'
+      resp.body
+    rescue SocketError
+      raise RuntimeError
     end
 
     def method_missing(sym, *args, &block)

data/lib/githubstats/data.rb

@@ -12,7 +12,11 @@ module GithubStats
   ##
   # Helper struct for defining datapoints
 
-  Datapoint = Struct.new(:date, :score)
+  Datapoint = Struct.new(:date, :score) do
+    def to_a
+      [date.strftime('%Y-%m-%d'), score.to_s]
+    end
+  end
 
   ##
   # Data class for calculations
@@ -31,7 +35,8 @@ module GithubStats
     def initialize(data)
       @raw = data.map { |d, s| Datapoint.new(Date.parse(d), s.to_i) }
       enable_caching %i[to_h today streaks longest_streak streak max mean
-                        std_var quartile_boundaries quartiles]
+                        std_var quartile_boundaries quartiles start_date
+                        end_date]
     end
 
     ##
@@ -43,6 +48,19 @@ module GithubStats
       end
     end
 
+    ##
+    # The start of the dataset
+
+    def start_date
+      @raw.first.date
+    end
+
+    ##
+    # The end of the dataset
+    def end_date
+      @raw.last.date
+    end
+
     ##
     # The score for today
 
@@ -162,7 +180,7 @@ module GithubStats
     # Return the quartile of a given score
 
     def quartile(score)
-      return nil if score < 0 || score > max.score
+      return nil if score.negative? || score > max.score
       quartile_boundaries.count { |bound| score > bound }
     end
 

data/lib/githubstats/version.rb

@@ -3,5 +3,5 @@
 ##
 # Define the version
 module GithubStats
-  VERSION = '1.4.0'.freeze
+  VERSION = '3.1.0'
 end

data/spec/githubstats/data_spec.rb

@@ -7,8 +7,8 @@ describe GithubStats do
   end
 
   it 'defines a Datapoint object' do
-    a = GithubStats::Datapoint.new(DateTime.now, 4)
-    expect(a.date).to be_an_instance_of DateTime
+    a = GithubStats::Datapoint.new(Time.now, 4)
+    expect(a.date).to be_an_instance_of Time
     expect(a.score).to eql 4
   end
 

data/spec/githubstats_spec.rb

@@ -10,7 +10,9 @@ describe GithubStats do
   describe GithubStats::User do
     let(:named_user) { GithubStats::User.new 'akerl' }
     let(:unnamed_user) { GithubStats::User.new }
-    let(:hash_user) { GithubStats::User.new(name: 'fly', url: 'URL-FOR-%s') }
+    let(:hash_user) do
+      GithubStats::User.new(name: 'fly', url: 'https://URL-%s')
+    end
 
     context 'when created with a string' do
       it 'uses that string as the username' do
@@ -30,7 +32,7 @@ describe GithubStats do
         expect(hash_user.name).to eql 'fly'
       end
       it 'uses the URL from the hash' do
-        expect(hash_user.url).to eql 'URL-FOR-fly'
+        expect(hash_user.url).to eql 'https://URL-fly'
       end
     end
 
@@ -39,7 +41,7 @@ describe GithubStats do
       expect(named_user.last_updated).to be_nil
       named_user.data
       expect(named_user.instance_variables).to include(:@data)
-      expect(named_user.last_updated).to be_an_instance_of DateTime
+      expect(named_user.last_updated).to be_an_instance_of Time
     end
 
     it 'raises an exception if it cannot load data' do

metadata

@@ -1,141 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: githubstats
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Les Aker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: curb
+  name: basiccache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: basiccache
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.10.8
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :runtime
+        version: 0.1.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 0.76.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 0.76.0
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 0.9.0
 description: Pulls the statistics from Github's user contribution chart and provides
   an interface for analyzing that data
 email: me@lesaker.org
@@ -149,13 +149,13 @@ files:
 - ".prospectus"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/githubstats
-- circle.yml
 - githubstats.gemspec
 - lib/githubstats.rb
 - lib/githubstats/data.rb
@@ -175,7 +175,7 @@ homepage: https://github.com/akerl/githubstats
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -190,9 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Present Github contributions stats in a consumable format
 test_files:

data/circle.yml

@@ -1,7 +0,0 @@
-dependencies:
-  override:
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i gem update --system --no-doc || exit 1 ; done'
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle install || exit 1 ; done'
-test:
-  override:
-  - 'for i in $(cat .circle-ruby) ; do rvm-exec $i bundle exec rake || exit 1 ; done'