geckoboard-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec98d0225989a8d02c83f7d46bf34ce25c88e3da
-  data.tar.gz: d5e3effe54d256a1f16cba2898f51352cf1975a2
+  metadata.gz: 761434e8773946c7a9a6f111acc2aa2814c44ff5
+  data.tar.gz: 6fd826b8679091d0c49126e495fce06c2a687d1c
 SHA512:
-  metadata.gz: 95d796bc880855c11290d9ceeb6b4885fb640cbf9cab6ae10e662e1093193ee582dc3b24d910d4ecb590a8e8290a306a6bb06a4939575bf7550208d93e273539
-  data.tar.gz: 6ccab0a19bf2f50637a66db7263871d43b9f84e91d56c5cf8b597314e3e475186503a0481187d87e981a3268fd26559187b5c64bb10452b109618a565887190a
+  metadata.gz: 6001b746389178795c7072919d982c116e217252be9be379c4ecf2ef0977b933f61c0b4e19e05878ea42e03aaaec428bdd6cf6b054c84d8d596d0d382e50099a
+  data.tar.gz: d80f695524f168add1407eb7bee8d2464a047210303d5b33cfd6128fba0b53ee5c25743ba6922f8a29b8f5793c002b32ec9842359830c4ccf66528844add6d64

data/README.md

@@ -36,9 +36,9 @@ Verify an existing dataset or create a new one.
 
 ```ruby
 dataset = client.datasets.find_or_create('sales.gross', fields: [
-  Geckoboard::MoneyField.new(:amount, name: 'Amount', currency: 'USD'),
+  Geckoboard::MoneyField.new(:amount, name: 'Amount', currency_code: 'USD'),
   Geckoboard::DateTimeField.new(:timestamp, name: 'Time'),
-])
+], unique_by: [:timestamp])
 ```
 
 Available field types:
@@ -50,6 +50,8 @@ Available field types:
 - `StringField`
 - `MoneyField`
 
+`unique_by` is an optional array of one or more field names whose values will be unique across all your records.
+
 ### Delete
 
 Delete a dataset and all data therein.
@@ -81,6 +83,25 @@ dataset.put([
 ])
 ```
 
+### Post
+
+Append data to a dataset.
+
+```ruby
+dataset.post([
+  {
+    timestamp: DateTime.new(2016, 1, 2, 12, 0, 0),
+    amount: 40900
+  },
+  {
+    timestamp: DateTime.new(2016, 1, 3, 12, 0, 0),
+    amount: 16400
+  },
+], delete_by: :timestamp)
+```
+
+`delete_by` is an optional field by which to order the truncation of records once the maximum record count has been reached. By default the oldest records (by insertion time) will be removed.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/geckoboard/connection.rb

@@ -26,6 +26,14 @@ module Geckoboard
       make_request(request)
     end
 
+    def post(path, body)
+      request = Net::HTTP::Post.new(path)
+      request['Content-Type'] = 'application/json'
+      request.body = body
+
+      make_request(request)
+    end
+
     private
 
     def make_request(request)

data/lib/geckoboard/dataset.rb

@@ -16,6 +16,10 @@ module Geckoboard
       client.put_data(id, payload_formatter.format(data))
     end
 
+    def post(data, options = {})
+      client.post_data(id, payload_formatter.format(data), options)
+    end
+
     private
 
     def payload_formatter

data/lib/geckoboard/datasets_client.rb

@@ -6,9 +6,11 @@ module Geckoboard
       @connection = connection
     end
 
-    def find_or_create(dataset_id, fields: nil)
+    def find_or_create(dataset_id, fields: nil, unique_by: nil)
       path = dataset_path(dataset_id)
-      response = connection.put(path, { fields: hashify_fields(fields) }.to_json)
+      body = { fields: hashify_fields(fields) }
+      body[:unique_by] = unique_by unless unique_by.nil?
+      response = connection.put(path, body.to_json)
 
       data = JSON.parse(response.body)
       Dataset.new(self, data.fetch('id'), data.fetch('fields'))
@@ -26,6 +28,13 @@ module Geckoboard
       true
     end
 
+    def post_data(dataset_id, data, options)
+      path = "#{dataset_path(dataset_id)}/data"
+      body = options.merge({ data: data }).to_json
+      connection.post(path, body)
+      true
+    end
+
     private
 
     def dataset_path(dataset_id)

data/lib/geckoboard/field_types.rb

@@ -39,17 +39,17 @@ module Geckoboard
   end
 
   class MoneyField < Field
-    attr_reader :currency
+    attr_reader :currency_code
 
-    def initialize(id, name: nil, currency: nil)
-      raise ArgumentError, "`currency:' is a required argument" if currency.nil?
+    def initialize(id, name: nil, currency_code: nil)
+      raise ArgumentError, "`currency_code:' is a required argument" if currency_code.nil?
 
       super(id, name: name)
-      @currency = currency
+      @currency_code = currency_code
     end
 
     def to_hash
-      super.merge(type: :money, currency: currency)
+      super.merge(type: :money, currency_code: currency_code)
     end
   end
 

data/lib/geckoboard/version.rb

@@ -1,3 +1,3 @@
 module Geckoboard
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geckoboard-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Upton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,4 +117,3 @@ signing_key:
 specification_version: 4
 summary: Ruby client library for Geckoboard
 test_files: []
-has_rdoc: