kittyverse 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2698032788d8346a7291346483e585502611d69c
-  data.tar.gz: f40553268c0458012235f9fbd7aa9a1eed690ec5
+  metadata.gz: 625692bc57c7cf12b02b4a08f18029b2fdbf2df8
+  data.tar.gz: b7e4e3d49b1fa36c78d93bd535a34533d6caf0bb
 SHA512:
-  metadata.gz: bf8ab2090846cafbb6c9673067247455c4607cad4a9fd89f852967ba70ad341661031e1b3d7b511ea2324e1e599f629074cfc216b397d0a60bc631f00f1e44ce
-  data.tar.gz: 53ec77865e458b19a4261b15bdd3fdabee440a171133cc3fe077ca71037aac79f76231c096be2c0a6178d484430dab2b0fbfd194e57576747808039ab709255e
+  metadata.gz: 4bc09276dc61fb29354e1af34ff88e6221b4c6a268d1e92fdaab8c35ce9c621e60afad1baaad5c52f8ce6683b8dbf6fd8a0b5fa6696b6f279639fd3090e78e85
+  data.tar.gz: 0ec559282248dcc5c17ff83d984d30e7ea306c393b74c6b3cea39e433be76c9a4c5fd7a4eb9c862e58cdb4206c369ed964dd0708e1b04f58731c296d179a3554

data/lib/kittyverse/api/client.rb

@@ -2,13 +2,71 @@
 
 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 )
@@ -23,7 +81,16 @@ def initialize( base_uri:, token: nil )
   @token = token
 end # method initialize
 
-def get( service )
+
+
+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 == "/"
@@ -32,25 +99,24 @@ def get( service )
                    "#{@base_request_uri}#{service}"  ## e.g. add /v1 etc.
                 end
 
-  headers = if @token
+  request_headers = if @token
              { "x-api-token" => @token }
             else
              {}
             end
 
-  req = Net::HTTP::Get.new( request_uri, headers )
+  req = Net::HTTP::Get.new( request_uri, request_headers )
 
   res = @http.request(req)
 
-   ## todo/fix: add check for res.code == "200"
-   ##   throw exception of fail
-
+  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
+    # 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"
@@ -61,10 +127,21 @@ def get( service )
   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  # methdo get
+end  # method get
 
 end  ## class Client
 

data/lib/kittyverse/api/versions.rb

@@ -30,6 +30,10 @@ 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
@@ -40,6 +44,14 @@ class Client < ::Kitties::Client
 
   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
 
@@ -58,6 +70,8 @@ class Client < ::Kitties::Client
 
   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

data/lib/kittyverse/version.rb

@@ -5,7 +5,7 @@ class Kittyverse
 
   MAJOR = 0
   MINOR = 4
-  PATCH = 2
+  PATCH = 3
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kittyverse
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2019-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base32-alphabets