im-alive 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b3fcfe6ed955de5b393d957655893c2662b8697
-  data.tar.gz: fbf714c7cc2d2eab0ea47f1b81f02fdec162cee1
+  metadata.gz: 5eb7065a4cb92ef9cae5f8c69f3406f2164ed260
+  data.tar.gz: 938235b37211713616231d8585a3ca71b205fc5f
 SHA512:
-  metadata.gz: 451a7d20d8a00e12e3842b1f1de11b40d64ea6e9818306dbc7c6daa6bb4453629e1514f8777c7e357d7f53a043d56aa42c5fc18d47a4696c261d6d3c2607c758
-  data.tar.gz: 270b56a1d34fa1b6d982cb632cd8f65ea6ee75c37b112d1841c3c8f53c52118f52f71ed05f142ea634a2935b35658f248f68a67a1ca6e4770292d5b05f61d2bb
+  metadata.gz: 72ab1bbd70d551436aa8ad5b576e1cc18cdef06b044e68b03789e12afe8e09770aae49cfd92d713279b608e27676546da1aee6e4aa8862cb0d53d8438b1842d3
+  data.tar.gz: d0fe1e403a08ce1cefbd43912c940f2fe9834f9a525e7e2b1d5182264364e68b4502131fa77db26b8fec44ead1cc6234b64e7a6d6d5cc8f0ff231525b61eaf2b

data/README.md

@@ -1,31 +1,26 @@
 # Im::Alive
 
-TODO: Write a gem description
+Post timestamps to a CouchDB database document. Useful for sending heartbeat signals or proving that an operation took place when it was supposed to. 
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'im-alive'
-```
+The timestamp information that is written is: 
 
-And then execute:
+`{"timestamp" => "2015-02-01 00:00:00 UTC", "js_timestamp" => 1422748800}`
 
-    $ bundle
+CouchDB documents can be acessed through HTTP GET request, no special tooling is required to read the values back out, you can use Curl, do it from JS in a web page, from any programming language you can think of etc etc. 
 
-Or install it yourself as:
+## Installation
 
-    $ gem install im-alive
+gem install im-alive
 
 ## Usage
 
-TODO: Write usage instructions here
+`im-alive https://username@password.heroku.cloudant.com/backups weekly`
+
+of which 
+- `https://username@password.heroku.cloudant.com` is the URL of the CouchDB instance
+- `backups` is the name of the CouchDB database. The database will be automatically created if it doesn't exist.
+- `weekly` it the name of the document to write the timestamps to. The document is created if it doesn't exist.
 
-## Contributing
+## Development
 
-1. Fork it ( https://github.com/alphasights/im-alive/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`)
-5. Create a new Pull Request
+Install the dependencies with `bundle install`, and run the tests with `bundle exec rake`.

data/Rakefile

@@ -1,7 +1,9 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
- Rake::TestTask.new do |t|
-   t.libs.push "spec"
-   t.test_files = FileList['spec/**/*_spec.rb']
- end
+Rake::TestTask.new(:test) do |t|
+  t.libs.push "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :test

data/im-alive.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "minitest", "~> 5.5"
   spec.add_development_dependency "timecop"
+  spec.add_development_dependency "rake"
 
   spec.add_runtime_dependency "couchrest", ["~> 2.0.0.rc2"]
 end

data/lib/im_alive/log.rb

@@ -9,7 +9,7 @@ module ImAlive
 
     def send
       doc = begin
-        db.get(document_id)
+        db.get!(document_id)
       rescue CouchRest::NotFound
         {'_id' => document_id}
       end

data/lib/im_alive/version.rb

@@ -1,3 +1,3 @@
 module ImAlive
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/log_spec.rb

@@ -9,7 +9,7 @@ module ImAlive
 
       Timecop.freeze Time.utc(2015, 02, 1, 0, 0, 0) do
         logger.stub :db, rest_client do
-          rest_client.expect :get, {}, ['polly']
+          rest_client.expect :get!, {}, ['polly']
           rest_client.expect :save_doc, {}, [{"timestamp" => "2015-02-01 00:00:00 UTC", "js_timestamp" => 1422748800}]
 
           logger.send

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
 require 'im_alive'
 require 'minitest/autorun'
-require 'minitest/pride'
 require 'timecop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: im-alive
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - David Griffiths
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: couchrest
   requirement: !ruby/object:Gem::Requirement
@@ -92,11 +106,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Sends a quick heartbeat timestamp to a document store.
 test_files:
 - spec/log_spec.rb
 - spec/spec_helper.rb
-has_rdoc: