githubstats 2.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c24647a4f63470021797a9309535a4438a830c1b
-  data.tar.gz: 7c42bba5c6566f54cab50f0e8873e0e1c3506a44
+SHA256:
+  metadata.gz: aa26d02c85e58b01ee8553a90a628aed98fa010b89142b056187d28467eb710a
+  data.tar.gz: b6671f2fa390ad49016cee0bc816a28d7063f7d2fc48a8b60aff5a6c4ebccdc0
 SHA512:
-  metadata.gz: ca040015df256cea023906e5504f59b38ca5fe552e2b3f4e44956e8faf9793be060896afa655252699e1f7d84d84673b3ebce091b8a53aac5ab7466ba9a787bb
-  data.tar.gz: 5cff21515fdd91ebba43d39cdb9fb6a3c95122f95a9f5fb2e1d205e98f0dc7ad72b64628a52bfeacc86d6721ff5af82109f2d7e952b1291fb162477802ce7085
+  metadata.gz: 4de055321d31ac225c4b519866a6a475268e20117daa8ba5f93164bfb00531d79722efadfe9bb655d81dc1cda91bb20d809f3d8c61657e1290b94e53f7c33f06
+  data.tar.gz: 7dd16f5fcb857c6f312123969f469080247886463d708fb270770bd169b35e1f192ae26e1dbc5b879d91a4c843bccabd7be72521b1f08b27f727e5c45647683f

data/.circle-ruby

@@ -1,3 +1,4 @@
-2.4.2
-2.3.5
-2.2.8
+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/.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.2.0 / 2021-02-06
+
+* [BUGFIX] Update to handle GitHub changes to contribution data CSS
+
+# 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

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/githubstats.gemspec

@@ -1,14 +1,15 @@
 require 'English'
-$LOAD_PATH.unshift File.expand_path('../lib/', __FILE__)
+$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.required_ruby_version = '>= 2.5.0'
 
   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' # rubocop:disable Metrics/LineLength
+  s.description = 'Pulls the statistics from Github\'s user contribution chart and provides an interface for analyzing that data' # rubocop:disable Layout/LineLength
   s.authors     = ['Les Aker']
   s.email       = 'me@lesaker.org'
   s.homepage    = 'https://github.com/akerl/githubstats'
@@ -18,15 +19,13 @@ 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.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.50.0'
-  s.add_development_dependency 'goodcop', '~> 0.1.0'
-  s.add_development_dependency 'rake', '~> 12.1.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.9.3'
+  s.add_development_dependency 'rake', '~> 13.0.0'
+  s.add_development_dependency 'rspec', '~> 3.9.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,7 +34,7 @@ module GithubStats
   ##
   # Default URL for grabbing data
 
-  DEFAULT_URL = "#{DEFAULT_HOST}/users/%s/contributions".freeze
+  DEFAULT_URL = "#{DEFAULT_HOST}/users/%s/contributions"
 
   ##
   # 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,42 +117,49 @@ 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
-      res = Curl::Easy.perform(url)
-      code = res.response_code
-      raise("Failed loading data from GitHub: #{url} #{code}") if code != 200
-      html = Nokogiri::HTML(res.body_str)
-      html.css('.day').map do |x|
+    def download(to_date = nil)
+      resp = request(to_date)
+      html = Nokogiri::HTML(resp)
+      svg = html.at_css('svg.js-calendar-graph-svg')
+      svg.css('.ContributionCalendar-day').map do |x|
         x.attributes.values_at('data-date', 'data-count').map(&:value)
       end
     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)
       load_data if @last_updated.nil?
       return super unless @data.respond_to? sym

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
 
@@ -102,7 +120,7 @@ module GithubStats
     # The mean score
 
     def mean
-      scores.reduce(:+) / @raw.size.to_f
+      scores.sum / @raw.size.to_f
     end
 
     ##
@@ -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
 
@@ -179,9 +197,7 @@ module GithubStats
     def _pad(data, index, fill_value, goal)
       mod = index * -2 - 1 # 0 index moves -1 in time, -1 move +1 in time
       point = GithubStats::Datapoint
-      until data[index].date.wday == goal
-        data.insert index, point.new(data[index].date + mod, fill_value)
-      end
+      data.insert index, point.new(data[index].date + mod, fill_value) until data[index].date.wday == goal
       data
     end
   end

data/lib/githubstats/version.rb

@@ -3,5 +3,5 @@
 ##
 # Define the version
 module GithubStats
-  VERSION = '2.0.0'.freeze
+  VERSION = '3.2.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,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: githubstats
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Les Aker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-29 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: curb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: basiccache
   requirement: !ruby/object:Gem::Requirement
@@ -44,112 +30,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.10.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.10.8
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: goodcop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.9.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.1.0
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.9.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
@@ -163,13 +135,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
@@ -189,7 +161,7 @@ homepage: https://github.com/akerl/githubstats
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -197,16 +169,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-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'