say_it_with_graphs 0.1.0 → 0.1.1.pre.alpha.pre.16

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 22ec0d37012cf44ccb9bb21eb0ec4a7ff0c15fef
-  data.tar.gz: 228761e63191d0923427a3dcd32ed10ae5405ab9
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmM3Mzc3YWJlNTMxNGVmYjUzNDM5MDU3MjMzNTk3YWMxNWY4ZmQ4Ng==
+  data.tar.gz: !binary |-
+    ZmUzMzAxODAwNWVjYWExMmU4NjQ4ZTRkNmU3NjBmNmI2N2Y1ZTA3NA==
 SHA512:
-  metadata.gz: b104f125fac78b4e2dfb6d7686c9154bf75bda780092dd56ad143f98a02acb34a133d69eb24205809b2a44f0c3423ce54e3347661ac13526be6e9d9d09adafbe
-  data.tar.gz: 5b0a6f283985266caaa7955d818649365afd5228ca96e9c7e3459792349b365311881e11f1d4ac5c0e7355ce886cb5ed4a5f46afdd64d23f944f04f0f3e0580c
+  metadata.gz: !binary |-
+    MzJjMzNiODdmZTQxZWJkYmE4N2M4Y2JhMzI2NjJlZjBiYmU2MGNlOTgyZDRl
+    OWI4MTA3ZThmOTYwMGZmYWUwY2Q5YjJlZDE3ZTcwMjk2ZGNiZjNmMDM4NGEw
+    MzQwNTc3MzBiNTEwYmI2MDJkNGVjMzQyNzVlZGVkNjM0YmQ5ZWU=
+  data.tar.gz: !binary |-
+    NTY5ZGFlZTVlNjNmODhkN2MwMzg4NzZmNzc1YjM3N2EwZGM0ZjZjYjY5NGZk
+    Mzk3NzlmYTVkM2E0MTI4Y2UzYWRkMmQzMzliZWMwZWUyMTM5OWU5MTk1NjQw
+    Nzk2MzQ0ZTkxOTBlNjUwMzhmMGI3ZTljNmU3Y2I0OGIyMGE0ZTI=

data/.travis.yml

@@ -7,3 +7,11 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: LcWSsGG1GhvdlDz0A9x02EcszoaS3bT7666XlN0s2bH713AWHNMIdK0GKQivpHdDFOzg6bj/UwSikWGaF/F01B8pnEmVxQoMLqudrjBIbnMpkZVcXNarP3oLOuPI+QdF6VEX4v9mrtjUd1nTTitMGn3DDk3gDhRRYbPIg5/UhkA=
+  gem: say_it_with_graphs
+  on:
+    repo: nesQuick/say-it-with-graphs

data/README.md

@@ -1,10 +1,20 @@
 # SayItWithGraphs [![Build Status](https://travis-ci.org/nesQuick/say-it-with-graphs.svg?branch=master)](https://travis-ci.org/nesQuick/say-it-with-graphs)
 
-TODO: Write a gem description
+Use [Librato Metrics](https://www.librato.com) to finally say something which should have been said long before.
+
+![](http://cl.ly/image/1F3B371E3r0v/2015-03-09%2000_57_07.gif)
+
+**Note: not all characters are supported yet, please feel free to contribute some. check `lib/say_it_with_graphs/characters` for available characters.**
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it yourself as:
+
+```bash
+$ gem install say_it_with_graphs
+```
+
+Or add this line to your application's Gemfile:
 
 ```ruby
 gem 'say_it_with_graphs'
@@ -12,19 +22,102 @@ gem 'say_it_with_graphs'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
+
+### Configure
+
+You need `LIBRATO_USER` and `LIBRATO_TOKEN` in your environment in order to make it work :sparkles:
 
-Or install it yourself as:
+You can find your tokens here: https://metrics.librato.com/account/api_tokens or simply create a new one.
 
-    $ gem install say_it_with_graphs
+## Quick Start
+
+Getting started in 5 minutes.
+
+```bash
+$ gem 'say_it_with_graphs'
+$ export LIBRATO_USER='<your user email here>'
+$ export LIBRATO_TOKEN='<your api token here>'
+$ say-it-with-graphs "I <3 GRAPHS\!"
+"making 'I <3 GRAPHS!' with <3 and graphs"
+"Painting to say-it-with-graphs-82 ... ETA: 29 minutes"
+"=> https://metrics.librato.com/metrics/say-it-with-graphs-82"
+"Frame 0 of 29"
+"Line[9f9845] pos: 0"
+"Line[9f9845] pos: 100"
+"Line[9f9845] pos: 0"
+"Frame 1 of 29"
+"Frame 2 of 29"
+"Line[27018a] pos: 50"
+"Line[db03f4] pos: 50"
+...........
+```
+
+`say-it-with-graphs` will paint your sentence onto a graph. you can find the url in the output.
 
 ## Usage
 
-TODO: Write usage instructions here
+The usage of the execuatable is described at [Quick Start](#Quick-Start). In this section we will discuss the API to create your own characters in `lib/say_it_with_graphs/characters`.
+
+### The frame
+
+Every frame has access to unlimited amount of lines. The most characters can be drawn with 2 or 3. Every character has to respond to two methods:
+
+1. `define`
+Defines returns the character which will be mathed against the user input.
+
+```ruby
+def define
+  'i'
+end
+```
+
+2. `draw`
+Draw does the actual magic. When you have the `SayItWithGraphs::GraphControls` included in your class, you can just call the `frame` method and pass it a block which gets a `frame` passed to it. As mentioned above the frame has access to a unlimited number of lines, you can access them in several ways, the easiest is `f.line` which gives back a `Line` object, you can set it's source with `[]` (defaults to 0).
+
+```ruby
+def draw
+  frame do |f|
+    f.line.at 0
+    f.line.at 100
+    f.line.at 0
+  end
+end
+```
+
+With this methods given, only graphs with a limited number of lines would be possible. It's hard to draw the characters with a single line (one could try implementing cursive handwriting). You have also access to a helper method called `rnd_line` which gives a key one can use to refer to a line which will not be used at other places in the drawning.
+
+```ruby
+def define
+  'l'
+end
+
+def draw
+  a = rnd_line
+  frame do |f|
+    f.line[a].at 100
+    f.line[a].at 0
+  end
+  frame do |f|
+    f.line[a].at 0
+  end
+  frame do |f|
+    f.line[a].at 0
+  end
+end
+```
+
+You can check out more complex examples like `lib/say_it_with_graphs/characters/r.rb` to see what's possible.
+
+## Disclaimer
+
+This is a weekend hack. There are a few ways this thing could be improved.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/say_it_with_graphs/fork )
+1. Fork it ( https://github.com/nesQuick/say_it_with_graphs/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/say_it_with_graphs/client.rb

@@ -8,6 +8,7 @@ module SayItWithGraphs
     # debug_output $stdout
 
     def self.submit value: value, source: source, name: 'say-it-with-graphs'
+      fail 'please provide valid credentials' unless ENV['LIBRATO_USER'] && ENV['LIBRATO_TOKEN']
       auth = { username: ENV['LIBRATO_USER'], password: ENV['LIBRATO_TOKEN'] }
       metric = {
         gauges: [{

data/lib/say_it_with_graphs/version.rb

@@ -1,3 +1,3 @@
 module SayItWithGraphs
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/say_it_with_graphs.gemspec

@@ -6,6 +6,7 @@ require 'say_it_with_graphs/version'
 Gem::Specification.new do |spec|
   spec.name          = "say_it_with_graphs"
   spec.version       = SayItWithGraphs::VERSION
+  spec.version       = "#{spec.version}-alpha-#{ENV['TRAVIS_BUILD_NUMBER']}" if ENV['TRAVIS']
   spec.authors       = ["Ole Michaelis"]
   spec.email         = ["Ole.Michaelis@googlemail.com"]
   spec.summary       = %q{Make more of your graphs. Write with them!}

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: say_it_with_graphs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1.pre.alpha.pre.16
 platform: ruby
 authors:
 - Ole Michaelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-08 00:00:00.000000000 Z
+date: 2015-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.5'
 description: say-it-with-graphs let you actually write into a place where usually
@@ -103,9 +103,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -154,17 +154,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Make more of your graphs. Write with them!