hubba 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3e04406b046b751a5eb400e8955417ae99498e7
-  data.tar.gz: 57752bfd47aea766d3db5c467659876216a644a0
+  metadata.gz: 122527cdc3cddb68e2c54a6e51fcfb77c2c91c0c
+  data.tar.gz: 6bb52baff0536f55ad969885fc8500b031457e44
 SHA512:
-  metadata.gz: f96d7fa167b0e7cf8b685674aa80d19eca790ad237a9ea43cd40650d1c799448ce5827b009bb84b9d14c774b991693e1b0570735bf6573f64ed2c0a9e46c1c1f
-  data.tar.gz: 5cbdcd4a949763f19ba6275cec64cc1f3cfda6b05abe02950721befac8df17b1a5a1d64d1e41ae8048d23c06b93f41436d69bde91338e81313aa6e19af89236a
+  metadata.gz: df4e036a205be30371ec9de85e8085717235922fcc21e22f9f516cc40481a2a8cf6a9b0edd0a37cb24759059a08b5ea74957f41f89139bf9e1a860ed20029e3b
+  data.tar.gz: 698fc0d240aa6c6f8b125d1ae004beacf5ae97c220eb42d4fd542a49a656ece101e3a9fd9e740eaefb63e7f03c132458872f4ea5949cd30e2eceb9ccc3bb9e54

data/Manifest.txt

@@ -1,21 +1,20 @@
-HISTORY.md
+CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
 lib/hubba.rb
-lib/hubba/cache.rb
 lib/hubba/client.rb
+lib/hubba/config.rb
 lib/hubba/github.rb
+lib/hubba/reports.rb
+lib/hubba/reposet.rb
 lib/hubba/stats.rb
 lib/hubba/version.rb
-test/cache/users~geraldb~orgs.json
-test/cache/users~geraldb~repos.json
 test/helper.rb
 test/stats/jekyll~minima.json
 test/stats/openblockchains~awesome-blockchains.json
 test/stats/opendatajson~factbook.json.json
 test/stats/poole~hyde.json
-test/test_cache.rb
 test/test_config.rb
 test/test_stats.rb
 test/test_stats_tmp.rb

data/README.md

@@ -1,20 +1,20 @@
-# hubba
-
-hubba gem - (yet) another (lite) GitHub HTTP API client / library
-
-* home  :: [github.com/gittiscripts/hubba](https://github.com/gittiscripts/hubba)
-* bugs  :: [github.com/gittiscripts/hubba/issues](https://github.com/gittiscripts/hubba/issues)
-* gem   :: [rubygems.org/gems/hubba](https://rubygems.org/gems/hubba)
-* rdoc  :: [rubydoc.info/gems/hubba](http://rubydoc.info/gems/hubba)
-
-
-## Usage
-
-TBD
-
-
-
-## License
-
-The `hubba` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
+# hubba
+
+hubba gem - (yet) another (lite) GitHub HTTP API client / library
+
+* home  :: [github.com/rubycoco/git](https://github.com/rubycoco/git)
+* bugs  :: [github.com/rubycoco/git/issues](https://github.com/rubycoco/git/issues)
+* gem   :: [rubygems.org/gems/hubba](https://rubygems.org/gems/hubba)
+* rdoc  :: [rubydoc.info/gems/hubba](http://rubydoc.info/gems/hubba)
+
+
+## Usage
+
+TBD
+
+
+
+## License
+
+The `hubba` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -8,23 +8,23 @@ Hoe.spec 'hubba' do
   self.summary = 'hubba - (yet) another (lite) GitHub HTTP API client / library'
   self.description = summary
 
-  self.urls    = ['https://github.com/gittiscripts/hubba']
+  self.urls    = { home: 'https://github.com/rubycoco/git' }
 
   self.author  = 'Gerald Bauer'
   self.email   = 'ruby-talk@ruby-lang.org'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'HISTORY.md'
+  self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
-    ['logutils' ],
+    ['webclient', '>= 0.1.1']
   ]
 
   self.licenses = ['Public Domain']
 
   self.spec_extras = {
-   required_ruby_version: '>= 2.3'
+   required_ruby_version: '>= 2.2.2'
   }
 
 end

data/lib/hubba.rb

@@ -1,25 +1,43 @@
-# encoding: utf-8
+# 3rd party (our own)
+require 'webclient'
 
-require 'net/http'
-require "net/https"
-require 'uri'
 
-require 'pp'
-require 'json'
-require 'yaml'
-require 'time'
+###############
+## helpers
+
+def save_json( path, data )    ## data - hash or array
+  File.open( path, 'w:utf-8' ) do |f|
+    f.write( JSON.pretty_generate( data ))
+  end
+end
+
+def save_yaml( path, data )
+  File.open( path, 'w:utf-8' ) do |f|
+    f.write( data.to_yaml )
+  end
+end
 
 
-# 3rd party gems/libs
-require 'logutils'
 
 # our own code
 require 'hubba/version'   # note: let version always go first
-require 'hubba/cache'
+require 'hubba/config'
 require 'hubba/client'
 require 'hubba/github'
 require 'hubba/stats'
 
+## "higher level" porcelain services / helpers for easy (re)use
+require 'hubba/reposet'
+
+require 'hubba/reports'
+
+
+############
+# add convenience alias for alternate spelling - why? why not?
+module Hubba
+  GitHub = Github
+end
+
 
 # say hello
-puts Hubba.banner    if defined?($RUBYLIBS_DEBUG)
+puts Hubba.banner    if defined?($RUBYCOCO_DEBUG)

data/lib/hubba/client.rb

@@ -1,53 +1,79 @@
-# encoding: utf-8
-
 module Hubba
 
 
 class Client
 
-def initialize( user: nil, password: nil )
-  uri = URI.parse( "https://api.github.com" )
-  @http = Net::HTTP.new(uri.host, uri.port)
-  @http.use_ssl = true
-  @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+BASE_URL = 'https://api.github.com'
+
+
+def initialize( token: nil,
+                user:  nil, password: nil )
+  ## add support for (personal access) token
+  @token     = token
 
   ## add support for basic auth - defaults to no auth (nil/nil)
+  ##   remove - deprecated (use token) - why? why not?
   @user      = user    ## use login like Oktokit - why? why not?
   @password  = password
 end # method initialize
 
+
+
 def get( request_uri )
   puts "GET #{request_uri}"
 
-  req = Net::HTTP::Get.new( request_uri )
-  ## req = Net::HTTP::Get.new( "/users/geraldb" )
-  ## req = Net::HTTP::Get.new( "/users/geraldb/repos" )
-  req["User-Agent"] = "ruby/hubba"                  ## required by GitHub API
-  req["Accept" ]    = "application/vnd.github.v3+json"  ## recommend by GitHub API
+  ## note: request_uri ALWAYS starts with leading /, thus use + for now!!!
+  #          e.g. /users/geraldb
+  #               /users/geraldb/repos
+  url = BASE_URL + request_uri
 
+  headers = {}
+  headers['User-Agent'] = 'ruby/hubba'                      ## required by GitHub API
+  headers['Accept']     = 'application/vnd.github.v3+json'  ## recommend by GitHub API
+
+  auth = []
   ## check if credentials (user/password) present - if yes, use basic auth
-  if @user && @password
+  if @token
+    puts "  using (personal access) token - starting with: #{@token[0..6]}**********"
+    headers['Authorization'] = "token #{@token}"
+    ## token works like:
+    ##  curl -H 'Authorization: token my_access_token' https://api.github.com/user/repos
+  elsif @user && @password
     puts "  using basic auth - user: #{@user}, password: ***"
-    req.basic_auth( @user, @password )
+    ## use credential auth "tuple" (that is, array with two string items) for now
+    ##  or use Webclient::HttpBasicAuth or something - why? why not?
+    auth = [@user, @password]
+    # req.basic_auth( @user, @password )
+  else
+    puts "  using no credentials (no token, no user/password)"
   end
 
-  res = @http.request(req)
+  res = Webclient.get( url,
+                       headers: headers,
+                       auth:    auth )
 
   # Get specific header
   # response["content-type"]
   # => "text/html; charset=UTF-8"
 
   # Iterate all response headers.
-  res.each_header do |key, value|
-    p "#{key} => #{value}"
-  end
+  # puts "HTTP HEADERS:"
+  # res.headers.each do |key, value|
+  #  puts "  #{key}: >#{value}<"
+  # end
+  # puts
+
   # => "location => http://www.google.com/"
   # => "content-type => text/html; charset=UTF-8"
   # ...
 
-  json = JSON.parse( res.body )
-  ## pp json
-  json
+  if res.status.ok?
+    res.json
+  else
+    puts "!! HTTP ERROR: #{res.status.code} #{res.status.message}:"
+    pp res.raw
+    exit 1
+  end
 end  # methdo get
 
 end  ## class Client

data/lib/hubba/config.rb

@@ -0,0 +1,51 @@
+module Hubba
+
+class Configuration
+  def data_dir()          @data_dir || './data'; end
+  def data_dir=( value )  @data_dir = value;     end
+
+  ###  todo/check: rename to/use tmp_dir - why? why not?
+  def cache_dir()         @cache_dir || './cache'; end
+  def cache_dir=( value ) @cache_dir = value;      end
+
+
+  # try default setup via ENV variables
+  def token()            @token || ENV[ 'HUBBA_TOKEN' ]; end
+  def token=( value )    @token = value;                 end
+
+  # todo/check: use HUBBA_LOGIN - why? why not?
+  def user()             @user     || ENV[ 'HUBBA_USER' ]; end
+  def password()         @password || ENV[ 'HUBBA_PASSWORD' ]; end
+  def user=( value )     @user     = value;                end
+  def password=( value ) @password = value;                end
+
+end  # class Configuration
+
+
+## lets you use
+##   Hubba.configure do |config|
+##      config.token    = 'secret'
+##        -or-
+##      config.user     = 'testdada'
+##      config.password = 'secret'
+##   end
+##
+##   move configure block to GitHub class - why? why not?
+##   e.g. GitHub.configure do |config|
+##          ...
+##        end
+
+
+def self.configuration
+ @configuration ||= Configuration.new
+end
+class << self
+  alias_method :config, :configuration
+end
+
+
+def self.configure
+ yield( configuration )
+end
+
+end # module Hubba

data/lib/hubba/github.rb

@@ -1,38 +1,5 @@
-# encoding: utf-8
-
 module Hubba
 
-class Configuration
-   attr_accessor :user
-   attr_accessor :password
-
-   def initialize
-     # try default setup via ENV variables
-     @user     = ENV[ 'HUBBA_USER' ]    ## use HUBBA_LOGIN - why? why not?
-     @password = ENV[ 'HUBBA_PASSWORD' ]
-   end
-end
-
-## lets you use
-##   Hubba.configure do |config|
-##      config.user     = 'testdada'
-##      config.password = 'secret'
-##   end
-##
-##   move configure block to GitHub class - why? why not?
-##   e.g. GitHub.configure do |config|
-##          ...
-##        end
-
-
-def self.configuration
-  @configuration ||= Configuration.new
-end
-
-def self.configure
-  yield( configuration )
-end
-
 
 class Resource
   attr_reader :data
@@ -53,25 +20,25 @@ class Orgs < Resource
     ## sort by name
     data.map { |item| item['login'] }.sort
   end
+  alias_method :names, :logins   ## add name alias - why? why not?
 end
 
 
 
 class Github
 
-def initialize( cache_dir: './cache' )
-   @cache  = Cache.new( cache_dir )
-   @client = Client.new( user:     Hubba.configuration.user,
-                         password: Hubba.configuration.password )
-
-   @offline = false
+def initialize
+   @client = if Hubba.configuration.token
+               Client.new( token: Hubba.configuration.token )
+             elsif Hubba.configuration.user &&
+                   Hubba.configuration.password
+               Client.new( user:     Hubba.configuration.user,
+                           password: Hubba.configuration.password )
+             else
+               Client.new
+             end
 end
 
-def offline!()  @offline = true; end   ## switch to offline  - todo: find a "better" way - why? why not?
-def online!()   @offline = false; end
-def offline?()  @offline == true; end
-def online?()   @offline == false; end
-
 
 def user( name )
   Resource.new( get "/users/#{name}" )
@@ -95,6 +62,7 @@ def user_orgs( name )
 end
 
 
+
 def org( name )
   Resource.new( get "/orgs/#{name}" )
 end
@@ -114,15 +82,56 @@ def repo_commits( full_name )
 end
 
 
-private
-def get( request_uri )
-  if offline?
-    @cache.get( request_uri )
+
+####
+# more
+def update( obj )
+  if obj.is_a?( Stats )
+    stats = obj
+    full_name = stats.full_name
+    puts "[update 1/2] fetching repo >#{full_name}<..."
+    repo    = repo( full_name )
+    puts "[update 2/2] fetching repo >#{full_name}< commits ..."
+    commits = repo_commits( full_name )
+
+    stats.update( repo, commits )
   else
-    @client.get( request_uri )
+    raise ArgumentError, "unknown source object passed in - expected Hubba::Stats; got #{obj.class.name}"
   end
 end
 
-end  # class Github
 
-end # module Hubba
+def update_stats( h )    ## todo/fix: change to Reposet - why? why not???
+    h.each do |org_with_counter,names|
+
+      ## remove optional number from key e.g.
+      ##   mrhydescripts (3)    =>  mrhydescripts
+      ##   footballjs (4)       =>  footballjs
+      ##   etc.
+
+      org = org_with_counter.sub( /\([0-9]+\)/, '' ).strip
+
+      ## puts "  -- #{key_with_counter} [#{key}] --"
+
+      names.each do |name|
+        full_name = "#{org}/#{name}"
+
+        ## puts "  fetching stats #{count+1}/#{repo_count} - >#{full_name}<..."
+        stats = Stats.new( full_name )
+        stats.read
+
+        update( stats )   ## fetch & update stats
+
+        stats.write
+      end
+    end
+end
+
+
+private
+def get( request_uri )
+  @client.get( request_uri )
+end
+
+end  # class Github
+end  # module Hubba