bitcat 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3897c5335d1664970852cc1e6396e7e434ea77b0
-  data.tar.gz: 3d4fbf418a8fa9b79348975e5e65a98867171dea
+  metadata.gz: eb4bbfbc8c988b0a34465d7eadb8c280798154b7
+  data.tar.gz: ac0405de5a5a71a094ec09623e5a3ced13f9a6db
 SHA512:
-  metadata.gz: 90c00dc574dc1abe59647162a65202d36bd7b905fe08312aa24021fef4a763a0dc042781a33cd1c4694d2b4bae5a8fbc38a77b99aac3734bb9c193eadb150bd3
-  data.tar.gz: 14048230792f6dbc58b13475ea00223187ed537c9302255298521dcf6e28b81c611af56c381349d43c5af19a7e7da44eb8de7d2886d22b4265979138020ccb01
+  metadata.gz: ade8e435c29b0a4c386fd105e569cbda1054ae348a3bd5691ffb60843488867c3a142c51046165833e215862ae1e3eaafcca4d889c207d3106d5431d271ffcc5
+  data.tar.gz: a2a826e1524d03dd48c7ff33ff6562c3fddb57943d06679ed53a3144681a9b3f9c050eae7251e0680490dd10dfdb017a99d9fdbc3e285ad1a2fd419b0ed33a47

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/Manifest.txt

@@ -1,6 +1,13 @@
 HISTORY.md
+LICENSE.md
 Manifest.txt
 README.md
 Rakefile
+bin/bitcat
 lib/bitcat.rb
+lib/bitcat/app.rb
+lib/bitcat/public/style.css
 lib/bitcat/version.rb
+lib/bitcat/views/index.erb
+lib/bitcat/views/kitty.erb
+lib/bitcat/views/layout.erb

data/README.md

@@ -1,4 +1,4 @@
-# bitcat - Bit Catalog Browser
+# bitcat - Bit Catalog Kitty Browser
 
 browse your (digital) bit(s) collections -
 browse your (crypto) kitties and more
@@ -10,11 +10,32 @@ browse your (crypto) kitties and more
 * rdoc  :: [rubydoc.info/gems/bitcat](http://rubydoc.info/gems/bitcat)
 
 
-
 ## Usage
 
-to be done
 
+### Step 0 - Database Setup
+
+Note: The bitcat server machinery requires a (local) single-file SQLite database,
+that is, `kitties.db`, in your working folder.
+
+See the [Copycats page on how to setup a (local) single-file SQLite database »](https://github.com/openblockchains/copycats#database-setup)
+
+
+
+### Step 1 - Start the Bitcat Server
+
+Start up the bitcat server on the command line:
+
+    $ bitcat
+
+
+### Step 3 - Open Bitcat Page in Browser
+
+Open up the browser at `localhost:4567`.
+
+![](bitcat.png)
+
+That's it. Enjoy.
 
 
 

data/Rakefile

@@ -18,6 +18,9 @@ Hoe.spec 'bitcat' do
   self.history_file = 'HISTORY.md'
 
   self.extra_deps = [
+    ['sinatra', '>=2.0'],
+    ['sass'],   ## used for css style preprocessing (scss)
+    ['copycats', '>=0.6.1'],
   ]
 
   self.licenses = ['Public Domain']

data/bin/bitcat

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -I./lib bin/bitcat
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/bitcat
+#
+
+require 'bitcat'
+
+Bitcat.main

data/lib/bitcat.rb

@@ -2,10 +2,54 @@
 
 require 'pp'
 
+## 3rd party
+require 'copycats'
+require 'sinatra/base'   ## note: use "modular" class sinatra style
+
+
 
 ## our own code
 require 'bitcat/version'    # note: let version always go first
+require 'bitcat/app'
+
+
+
+module Bitcat
+
+   ## convenience method
+   def self.run!
+     app    = App
+     port   = 4567
+     Rack::Handler::WEBrick.run( app, Port:port ) do |server|
+       ## todo: add traps here - why, why not??
+     end
+   end
+
+   def self.main
+     p banner
+     ##  p root   #=> e.g. "C:/Sites/openblockchains/bitcat"
+
+     database = './kitties.db'
+
+     unless File.exist?( database )
+       puts "*** error - no SQLite database found - expected >#{database}<"
+       puts
+       puts "  note: for how to setup a database,"
+       puts "        see <https://github.com/openblockchains/copycats#database-setup>"
+       puts
+       exit 1
+     end
+
+
+     ## connect to local kitties.db database
+     connect( adapter:  'sqlite3',
+              database:  database )
 
+     ## print some (record) stats
+     puts "kitties: #{Copycats::Model::Kitty.count}"
+     puts "genes:   #{Copycats::Model::Gene.count}"
+     puts "traits:  #{Copycats::Model::Trait.count}"
 
-pp Bitcat.banner
-pp Bitcat.root
+     run!
+   end
+end # module Bitcat

data/lib/bitcat/app.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module Bitcat
+
+class App < Sinatra::Base
+
+  set :root, "#{Bitcat.root}/lib/bitcat"
+
+  get '/' do
+    erb :index
+  end
+
+  post '/' do
+    puts "post '/'"
+    pp params
+
+    id = params['kitty']['id']
+    if id.blank?
+      ## id required - todo: add flash message
+      redirect "/"
+    else
+      redirect "/kitty/#{id}"
+    end
+  end
+
+
+  get '/kitty/:id' do
+    puts "get '/kitty/:id'"
+    pp params
+
+    kitty = Copycats::Model::Kitty.find( params['id'] )
+    pp kitty
+
+    erb :kitty, :locals => { kitty: kitty }
+  end
+
+
+## helpers
+  def h(text)
+    Rack::Utils.escape_html(text)
+  end
+
+end  # class App
+end # module Bitcat

data/lib/bitcat/public/style.css

@@ -0,0 +1,5 @@
+
+body {
+  font-family: arial,sans-serif;
+  color: #222;
+}

data/lib/bitcat/version.rb

@@ -4,8 +4,8 @@
 module Bitcat
 
   MAJOR = 0
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/bitcat/views/index.erb

@@ -0,0 +1,16 @@
+<h1>Bitcat - Bit Catalog Kitty Browser</h1>
+
+<div>
+  <form action='/' method='post'>
+    <input type='text' name='kitty[id]' placeholder='1,2,3,...'>
+    <input type='submit' value='Show Kitty'>
+  </form>
+</div>
+
+
+<p>
+Try
+  <% Copycats::Model::Kitty.limit(10).each do |kitty| %>
+     <a href="kitty/<%= kitty.id %>">#<%= kitty.id %></a>
+  <% end %>
+</p>

data/lib/bitcat/views/kitty.erb

@@ -0,0 +1,53 @@
+
+<a href="/">« Index</a>
+
+<h1>Kitty #<%= kitty.id %></h2>
+
+Generation: <%= kitty.gen %>
+<br>
+Birthdate:  <%= kitty.birthdate %>  (<%= Date.today.jd - kitty.birthdate.to_date.jd %> days ago)
+<br>
+Day count:  <%= kitty.day_count %>
+<br>
+Genes (Kai): <%= kitty.genes_kai %>
+
+
+<ul>
+<% kitty.genes.each do |gene|
+      trait      = Copycats::Model::Trait.find( gene.trait_id )
+      trait_type = Copycats::Model::TraitType.find( trait.trait_type_id )
+   %>
+ <li>
+   <%= gene.n %> --
+   <%= gene.gene %> -
+   <%= trait.name %>
+   (<%= trait.kai %>) -
+   <%= trait_type.name %>
+ </li>
+<% end %>
+</ul>
+
+
+<p>
+More Profile Pages:
+</p>
+
+<ul>
+  <li>CryptoKitty - <a href="https://www.cryptokitties.co/kitty/<%= kitty.id %>">#<%= kitty.id %></a>
+      (<a href="https://api.cryptokitties.co/kitties/<%= kitty.id %>">API</a>)
+  </li>
+  <li>CryptoKittydex - <a href="https://cryptokittydex.com/kitties/<%= kitty.id %>">#<%= kitty.id %></a>
+  </li>
+  <!-- check: needs "dummy" k2 para ? -->
+  <li>KittyCalc - <a href="https://kittycalc.co/read/?k1=<%= kitty.id %>&k2=461679">#<%= kitty.id %></a>
+  </li>
+</ul>
+
+
+<!--
+<pre>
+<%=h kitty.pretty_inspect %>
+
+<%=h kitty.genes.pretty_inspect %>
+</pre>
+-->

data/lib/bitcat/views/layout.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Bitcat - Bit Catalog Kitty Browser</title>
+  <link href='/style.css' rel='stylesheet'>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitcat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -10,6 +10,48 @@ bindir: bin
 cert_chain: []
 date: 2018-03-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: copycats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -41,19 +83,28 @@ dependencies:
 description: bitcat - bit cat(alog) browser - browse your (digital) bit(s) collections;
   browse your (crypto) kitties and more
 email: wwwmake@googlegroups.com
-executables: []
+executables:
+- bitcat
 extensions: []
 extra_rdoc_files:
 - HISTORY.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 files:
 - HISTORY.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/bitcat
 - lib/bitcat.rb
+- lib/bitcat/app.rb
+- lib/bitcat/public/style.css
 - lib/bitcat/version.rb
+- lib/bitcat/views/index.erb
+- lib/bitcat/views/kitty.erb
+- lib/bitcat/views/layout.erb
 homepage: https://github.com/openblockchains/bitcat
 licenses:
 - Public Domain