kittyverse 0.4.5 → 0.5.0

data/Rakefile

@@ -1,30 +1,30 @@
-require 'hoe'
-require './lib/kittyverse/version.rb'
-
-Hoe.spec 'kittyverse' do
-
-  self.version = Kittyverse::VERSION
-
-  self.summary = "kittyverse - helper classes for cattributes, trait types, traits, genes, genomes and more for cryptokitties and copycats"
-  self.description = summary
-
-  self.urls    = ['https://github.com/cryptocopycats/kittyverse']
-
-  self.author  = 'Gerald Bauer'
-  self.email   = 'wwwmake@googlegroups.com'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file  = 'README.md'
-  self.history_file = 'CHANGELOG.md'
-
-  self.extra_deps = [
-    ['base32-alphabets', '>= 1.0.0']
-  ]
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-    required_ruby_version: '>= 2.2.2'
-  }
-
-end
+require 'hoe'
+require './lib/kittyverse/version.rb'
+
+Hoe.spec 'kittyverse' do
+
+  self.version = Kittyverse::VERSION
+
+  self.summary = "kittyverse - helper classes for cattributes, trait types, traits, genes, genomes and more for cryptokitties and copycats"
+  self.description = summary
+
+  self.urls    = ['https://github.com/cryptocopycats/kittyverse']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['base32-alphabets', '>= 1.0.0']
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/kittyverse.rb

@@ -1,47 +1,47 @@
-# encoding: utf-8
-
-## std libs
-require 'date'
-require 'json'
-require 'pp'
-require 'uri'
-require 'net/http'
-require 'net/https'
-require 'fileutils'
-
-
-## 3rd party libs
-require 'base32-alphabets'
-
-
-## our own code
-require 'kittyverse/version'    # note: let version always go first
-
-require 'kittyverse/config/traits'
-require 'kittyverse/config/traits_timeline'
-require 'kittyverse/config/fancies'
-require 'kittyverse/config/purrstiges'
-require 'kittyverse/config/colors'
-
-
-require 'kittyverse/mewtations'
-require 'kittyverse/links'
-
-require 'kittyverse/pages/genes'
-
-require 'kittyverse/recipes'
-require 'kittyverse/traits'
-require 'kittyverse/cattributes'
-require 'kittyverse/fancies'
-
-## api support
-require 'kittyverse/api/client'
-require 'kittyverse/api/versions'
-
-## genes / genome
-require 'kittyverse/gene'
-require 'kittyverse/genome'
-
-
-# say hello
-puts Kittyverse.banner    if defined?($RUBYCOCO_DEBUG) && $RUBYCOCO_DEBUG
+# encoding: utf-8
+
+## std libs
+require 'date'
+require 'json'
+require 'pp'
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'fileutils'
+
+
+## 3rd party libs
+require 'base32-alphabets'
+
+
+## our own code
+require 'kittyverse/version'    # note: let version always go first
+
+require 'kittyverse/config/traits'
+require 'kittyverse/config/traits_timeline'
+require 'kittyverse/config/fancies'
+require 'kittyverse/config/purrstiges'
+require 'kittyverse/config/colors'
+
+
+require 'kittyverse/mewtations'
+require 'kittyverse/links'
+
+require 'kittyverse/pages/genes'
+
+require 'kittyverse/recipes'
+require 'kittyverse/traits'
+require 'kittyverse/cattributes'
+require 'kittyverse/fancies'
+
+## api support
+require 'kittyverse/api/client'
+require 'kittyverse/api/versions'
+
+## genes / genome
+require 'kittyverse/gene'
+require 'kittyverse/genome'
+
+
+# say hello
+puts Kittyverse.banner    if defined?($RUBYCOCO_DEBUG) && $RUBYCOCO_DEBUG

data/lib/kittyverse/api/client.rb

@@ -1,147 +1,147 @@
-# encoding: utf-8
-
-module Kitties
-
-  class Error < StandardError
-  end
-
-  ####
-  # todo/check:
-  #  rename to HttpRequestError or similar??
-  #  use "common" error class - why? why not?
-  class HttpError < Error
-    attr_reader :code, :message
-
-    def initialize( code, message )
-      @code, @message = code, message
-    end
-
-    def to_s
-      "HTTP request failed (NOK) => #{@code} #{@message}"
-    end
-  end
-
-
-  class Response    ## track last response
-    attr_accessor :code,    :message,
-                  :headers, :body
-
-    def initialize( code, message, headers, body )
-      @code, @message, @headers, @body = code, message, headers, body
-    end
-
-    ## ratelimit convenience helpers (for headers)
-    ##  note: all values of headers are arrays e.g.:
-    ##         {"x-ratelimit-limit"=>["20"],
-    ##          "x-ratelimit-remaining"=>["19"],
-    ##          "x-ratelimit-reset"=>["1558206970"],
-    ##          "content-length"=>["776"], ... }
-
-    def ratelimit_limit
-      limit = @headers['x-ratelimit-limit']
-      limit ? limit[0].to_i : nil
-    end
-
-    def ratelimit_remaining
-      remaining = @headers['x-ratelimit-remaining']
-      remaining ? remaining[0].to_i : nil
-    end
-
-    def ratelimit_reset?
-      ## x-ratelimit-reset => 1558079593   ## - assume it's unix epoch time
-      reset = @headers['x-ratelimit-reset']
-      reset ? (reset[0].to_i < Time.now.to_i) : true  ## always assume true (unlimited requests)
-    end
-
-    def ratelimit_reset
-      ## x-ratelimit-reset => 1558079593   ## - assume it's unix epoch time
-      reset = @headers['x-ratelimit-reset']
-      reset ? Time.at(reset[0].to_i) : nil
-    end
-  end  ## class Response (used for tracking last(_response))
-
-
-
-class Client
-
-##
-## todo: add (optional) close with @http.close - why? why not?
-
-def initialize( base_uri:, token: nil )
-  uri = URI.parse( base_uri )
-  @http = Net::HTTP.new( uri.host, uri.port )
-  if uri.instance_of? URI::HTTPS
-    @http.use_ssl = true
-    @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-  end
-
-  @base_request_uri  = uri.request_uri    ## e.g. save /v1 etc.
-  ## puts "base_request_uri: >#{@base_request_uri}<"
-
-  @request_headers = if token
-                      { "x-api-token" => token  }
-                     else
-                      {}
-                     end
-end # method initialize
-
-def get( service, **params )
-
-  ## add url-encoded query string from params hash e.g. ?limit=100&type=sale
-  unless params.empty?
-    query = URI.encode_www_form( params )
-    service += "?#{query}"
-  end
-
-  puts "GET #{service}"
-
-  request_uri = if @base_request_uri == "/"
-                    service
-                else
-                   "#{@base_request_uri}#{service}"  ## e.g. add /v1 etc.
-                end
-
-  pp @request_headers
-
-  req = Net::HTTP::Get.new( request_uri, @request_headers )
-
-  res = @http.request(req)
-
-  headers = res.to_hash   ## get all response headers
-
-  if Kitties.debug?
-    # Iterate all response headers.
-    # res.each_header do |key, value|
-    #  p "#{key} => #{value}"
-    # end
-    pp headers
-    # => "content-type => application/json; charset=utf-8"
-    # => "x-ratelimit-limit => 20"
-    # => "x-ratelimit-remaining => 19"
-    # => "x-ratelimit-reset => 1558079593"
-    # ...
-  end
-
-  body = res.read_body
-  ## pp body
-
-  ## track last response
-  Kitties.last_response = Response.new( res.code,
-                                        res.message,
-                                        headers,
-                                        body )
-
-  if res.code != '200'
-    raise HttpError.new( res.code, res.message )
-  end
-
-
-  json = JSON.parse( body )  ## use just body (any difference?) -  why? why not?
-  ## pp json
-  json
-end  # method get
-
-end  ## class Client
-
-
-end # module Kitties
+# encoding: utf-8
+
+module Kitties
+
+  class Error < StandardError
+  end
+
+  ####
+  # todo/check:
+  #  rename to HttpRequestError or similar??
+  #  use "common" error class - why? why not?
+  class HttpError < Error
+    attr_reader :code, :message
+
+    def initialize( code, message )
+      @code, @message = code, message
+    end
+
+    def to_s
+      "HTTP request failed (NOK) => #{@code} #{@message}"
+    end
+  end
+
+
+  class Response    ## track last response
+    attr_accessor :code,    :message,
+                  :headers, :body
+
+    def initialize( code, message, headers, body )
+      @code, @message, @headers, @body = code, message, headers, body
+    end
+
+    ## ratelimit convenience helpers (for headers)
+    ##  note: all values of headers are arrays e.g.:
+    ##         {"x-ratelimit-limit"=>["20"],
+    ##          "x-ratelimit-remaining"=>["19"],
+    ##          "x-ratelimit-reset"=>["1558206970"],
+    ##          "content-length"=>["776"], ... }
+
+    def ratelimit_limit
+      limit = @headers['x-ratelimit-limit']
+      limit ? limit[0].to_i : nil
+    end
+
+    def ratelimit_remaining
+      remaining = @headers['x-ratelimit-remaining']
+      remaining ? remaining[0].to_i : nil
+    end
+
+    def ratelimit_reset?
+      ## x-ratelimit-reset => 1558079593   ## - assume it's unix epoch time
+      reset = @headers['x-ratelimit-reset']
+      reset ? (reset[0].to_i < Time.now.to_i) : true  ## always assume true (unlimited requests)
+    end
+
+    def ratelimit_reset
+      ## x-ratelimit-reset => 1558079593   ## - assume it's unix epoch time
+      reset = @headers['x-ratelimit-reset']
+      reset ? Time.at(reset[0].to_i) : nil
+    end
+  end  ## class Response (used for tracking last(_response))
+
+
+
+class Client
+
+##
+## todo: add (optional) close with @http.close - why? why not?
+
+def initialize( base_uri:, token: nil )
+  uri = URI.parse( base_uri )
+  @http = Net::HTTP.new( uri.host, uri.port )
+  if uri.instance_of? URI::HTTPS
+    @http.use_ssl = true
+    @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+  end
+
+  @base_request_uri  = uri.request_uri    ## e.g. save /v1 etc.
+  ## puts "base_request_uri: >#{@base_request_uri}<"
+
+  @request_headers = if token
+                      { "x-api-token" => token  }
+                     else
+                      {}
+                     end
+end # method initialize
+
+def get( service, **params )
+
+  ## add url-encoded query string from params hash e.g. ?limit=100&type=sale
+  unless params.empty?
+    query = URI.encode_www_form( params )
+    service += "?#{query}"
+  end
+
+  puts "GET #{service}"
+
+  request_uri = if @base_request_uri == "/"
+                    service
+                else
+                   "#{@base_request_uri}#{service}"  ## e.g. add /v1 etc.
+                end
+
+  pp @request_headers
+
+  req = Net::HTTP::Get.new( request_uri, @request_headers )
+
+  res = @http.request(req)
+
+  headers = res.to_hash   ## get all response headers
+
+  if Kitties.debug?
+    # Iterate all response headers.
+    # res.each_header do |key, value|
+    #  p "#{key} => #{value}"
+    # end
+    pp headers
+    # => "content-type => application/json; charset=utf-8"
+    # => "x-ratelimit-limit => 20"
+    # => "x-ratelimit-remaining => 19"
+    # => "x-ratelimit-reset => 1558079593"
+    # ...
+  end
+
+  body = res.read_body
+  ## pp body
+
+  ## track last response
+  Kitties.last_response = Response.new( res.code,
+                                        res.message,
+                                        headers,
+                                        body )
+
+  if res.code != '200'
+    raise HttpError.new( res.code, res.message )
+  end
+
+
+  json = JSON.parse( body )  ## use just body (any difference?) -  why? why not?
+  ## pp json
+  json
+end  # method get
+
+end  ## class Client
+
+
+end # module Kitties

data/lib/kittyverse/api/versions.rb

@@ -1,91 +1,91 @@
-# encoding: utf-8
-
-module Kitties
-
-class Configuration
-   attr_accessor :token
-   attr_accessor :debug
-
-   def initialize
-     # try default setup via ENV variables
-     @token    = ENV[ 'KITTIES_TOKEN' ]
-     @debug    = false
-   end
-end
-
-## lets you use
-##   Kitties.configure do |config|
-##      config.token    = 'secret'
-##   end
-def self.configuration
-  @configuration ||= Configuration.new
-end
-
-def self.configure
-  yield( configuration )
-end
-
-### debug convenience helpers
-def self.debug?()       configuration.debug; end
-def self.debug=(value)  configuration.debug = value; end
-
-
-## track last response
-def self.last_response()       @last_response; end
-def self.last_response=(value) @last_response = value; end
-
-
-
-module V0
-class Client < ::Kitties::Client
-  def initialize
-    super( base_uri: "https://api.cryptokitties.co" )
-  end
-
-  def get_cattributes()  get('/cattributes'); end
-  def get_kitty( id )    get("/kitties/#{id}"); end   ## use get_kitty_by_id - why? why not?
-  alias_method :get_kitten, :get_kitty
-
-  def get_kitties( **params )  get( '/kitties', **params ); end
-  def get_auctions( **params ) get( '/auctions', **params ); end
-  def get_user( addr )  get( "/user/#{addr}" ); end
-
-  def get_network_status() get( '/network-status' ); end
-
-end # class Client
-end # module V0
-
-
-
-
-module V1
-###
-##  see https://docs.api.cryptokitties.co
-
-class Client < ::Kitties::Client
-  def initialize
-    super( base_uri: "https://public.api.cryptokitties.co/v1",
-           token:    Kitties.configuration.token )
-  end
-
-  def get_cattributes()      get('/cattributes'); end
-  def get_kitty( id )        get("/kitties/#{id}"); end  ## use get_kitty_by_id - why? why not?
-  alias_method :get_kitten, :get_kitty
-
-  def get_colors_body()      get('/colors/body'); end
-  def get_colors_eyes()      get('/colors/eyes'); end
-  def get_colors_secondary() get('/colors/secondary'); end
-  def get_colors_tertiary()  get('/colors/tertiary'); end
-
-end # class Client
-end  # module V1
-
-
-
-## CLIENT_V0 = V0::Client.new
-## CLIENT_V1 = V1::Client.new
-##
-## def self.v0()  CLIENT_V0; end
-## def self.v1()  CLIENT_V1; end
-
-end # module Kitties
+# encoding: utf-8
+
+module Kitties
+
+class Configuration
+   attr_accessor :token
+   attr_accessor :debug
+
+   def initialize
+     # try default setup via ENV variables
+     @token    = ENV[ 'KITTIES_TOKEN' ]
+     @debug    = false
+   end
+end
+
+## lets you use
+##   Kitties.configure do |config|
+##      config.token    = 'secret'
+##   end
+def self.configuration
+  @configuration ||= Configuration.new
+end
+
+def self.configure
+  yield( configuration )
+end
+
+### debug convenience helpers
+def self.debug?()       configuration.debug; end
+def self.debug=(value)  configuration.debug = value; end
+
+
+## track last response
+def self.last_response()       @last_response; end
+def self.last_response=(value) @last_response = value; end
+
+
+
+module V0
+class Client < ::Kitties::Client
+  def initialize
+    super( base_uri: "https://api.cryptokitties.co" )
+  end
+
+  def get_cattributes()  get('/cattributes'); end
+  def get_kitty( id )    get("/kitties/#{id}"); end   ## use get_kitty_by_id - why? why not?
+  alias_method :get_kitten, :get_kitty
+
+  def get_kitties( **params )  get( '/kitties', **params ); end
+  def get_auctions( **params ) get( '/auctions', **params ); end
+  def get_user( addr )  get( "/user/#{addr}" ); end
+
+  def get_network_status() get( '/network-status' ); end
+
+end # class Client
+end # module V0
+
+
+
+
+module V1
+###
+##  see https://docs.api.cryptokitties.co
+
+class Client < ::Kitties::Client
+  def initialize
+    super( base_uri: "https://public.api.cryptokitties.co/v1",
+           token:    Kitties.configuration.token )
+  end
+
+  def get_cattributes()      get('/cattributes'); end
+  def get_kitty( id )        get("/kitties/#{id}"); end  ## use get_kitty_by_id - why? why not?
+  alias_method :get_kitten, :get_kitty
+
+  def get_colors_body()      get('/colors/body'); end
+  def get_colors_eyes()      get('/colors/eyes'); end
+  def get_colors_secondary() get('/colors/secondary'); end
+  def get_colors_tertiary()  get('/colors/tertiary'); end
+
+end # class Client
+end  # module V1
+
+
+
+## CLIENT_V0 = V0::Client.new
+## CLIENT_V1 = V1::Client.new
+##
+## def self.v0()  CLIENT_V0; end
+## def self.v1()  CLIENT_V1; end
+
+end # module Kitties