geckoboard-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 911c6fae3e14c01c56dcee219a1a0a36ea7f6c8f
-  data.tar.gz: e3d5e9c25f948e6c650feb253fc724c78860b2e6
+  metadata.gz: ec98d0225989a8d02c83f7d46bf34ce25c88e3da
+  data.tar.gz: d5e3effe54d256a1f16cba2898f51352cf1975a2
 SHA512:
-  metadata.gz: de07437d8fec724846db64021ea804a0973cf688b1da0a2292612bc3b43e7e68be5715f6f18ac8911afdb09cb665e9d7579f88b47fff8269bd925a9669b5d8bc
-  data.tar.gz: 7bbaa3a2567654fe4ead80bc105d53fcd2b2a0d9bbbd582fdaa0b09fff821d3bfa5d5486d2d57e116b9f1a85b1683721217563b40b92ec9e9d2a5d496577ff30
+  metadata.gz: 95d796bc880855c11290d9ceeb6b4885fb640cbf9cab6ae10e662e1093193ee582dc3b24d910d4ecb590a8e8290a306a6bb06a4939575bf7550208d93e273539
+  data.tar.gz: 6ccab0a19bf2f50637a66db7263871d43b9f84e91d56c5cf8b597314e3e475186503a0481187d87e981a3268fd26559187b5c64bb10452b109618a565887190a

data/README.md

@@ -1,7 +1,7 @@
 # geckoboard-ruby
 [![CircleCI](https://circleci.com/gh/geckoboard/geckoboard-ruby.svg?style=svg)](https://circleci.com/gh/geckoboard/geckoboard-ruby)
 
-Ruby client library for Geckoboard (https://developer.geckoboard.com).
+Ruby client library for Geckoboard (https://developer.geckoboard.com/api-reference/ruby).
 
 ## Installation
 
@@ -35,18 +35,21 @@ client.ping # => true
 Verify an existing dataset or create a new one.
 
 ```ruby
-dataset = client.datasets.find_or_create('sales.gross', fields: {
-  amount: {
-    type: :number,
-    name: 'Amount',
-  },
-  timestamp: {
-    type: :datetime,
-    name: 'Time'
-  }
-})
+dataset = client.datasets.find_or_create('sales.gross', fields: [
+  Geckoboard::MoneyField.new(:amount, name: 'Amount', currency: 'USD'),
+  Geckoboard::DateTimeField.new(:timestamp, name: 'Time'),
+])
 ```
 
+Available field types:
+
+- `DateField`
+- `DateTimeField`
+- `NumberField`
+- `PercentageField`
+- `StringField`
+- `MoneyField`
+
 ### Delete
 
 Delete a dataset and all data therein.
@@ -69,11 +72,11 @@ Replace all data in the dataset.
 dataset.put([
   {
     timestamp: DateTime.new(2016, 1, 2, 12, 0, 0),
-    amount: 409
+    amount: 40900
   },
   {
     timestamp: DateTime.new(2016, 1, 3, 12, 0, 0),
-    amount: 164
+    amount: 16400
   },
 ])
 ```

data/lib/geckoboard/datasets_client.rb

@@ -6,9 +6,9 @@ module Geckoboard
       @connection = connection
     end
 
-    def find_or_create(dataset_id, fields: {})
+    def find_or_create(dataset_id, fields: nil)
       path = dataset_path(dataset_id)
-      response = connection.put(path, { fields: fields }.to_json)
+      response = connection.put(path, { fields: hashify_fields(fields) }.to_json)
 
       data = JSON.parse(response.body)
       Dataset.new(self, data.fetch('id'), data.fetch('fields'))
@@ -31,5 +31,17 @@ module Geckoboard
     def dataset_path(dataset_id)
       "/datasets/#{CGI.escape(dataset_id)}"
     end
+
+    def hashify_fields(fields)
+      return fields if fields.is_a? Hash
+
+      unless fields.respond_to?(:inject) && fields.all? { |field| field.is_a? Field }
+        raise ArgumentError, "`fields:' must be either a hash of field definitions, or collection of `Geckoboard::Field' objects"
+      end
+
+      fields.inject({}) do |hash, field|
+        hash.merge(field.id => field.to_hash)
+      end
+    end
   end
 end

data/lib/geckoboard/field_types.rb

@@ -0,0 +1,61 @@
+module Geckoboard
+  class Field
+    attr_reader :id, :name
+
+    def initialize(id, name: nil)
+      raise ArgumentError, "`name:' is a required argument" if name.nil?
+
+      @id   = id
+      @name = name
+    end
+
+    def to_hash
+      { name: name }
+    end
+  end
+
+  class StringField < Field
+    def to_hash
+      super.merge(type: :string)
+    end
+  end
+
+  class NumberField < Field
+    def to_hash
+      super.merge(type: :number)
+    end
+  end
+
+  class DateField < Field
+    def to_hash
+      super.merge(type: :date)
+    end
+  end
+
+  class DateTimeField < Field
+    def to_hash
+      super.merge(type: :datetime)
+    end
+  end
+
+  class MoneyField < Field
+    attr_reader :currency
+
+    def initialize(id, name: nil, currency: nil)
+      raise ArgumentError, "`currency:' is a required argument" if currency.nil?
+
+      super(id, name: name)
+      @currency = currency
+    end
+
+    def to_hash
+      super.merge(type: :money, currency: currency)
+    end
+  end
+
+  class PercentageField < Field
+    def to_hash
+      super.merge(type: :percentage)
+    end
+  end
+end

data/lib/geckoboard/version.rb

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

data/lib/geckoboard.rb

@@ -9,6 +9,7 @@ require 'geckoboard/datasets_client'
 require 'geckoboard/dataset'
 require 'geckoboard/payload_formatter'
 require 'geckoboard/errors'
+require 'geckoboard/field_types'
 
 module Geckoboard
   USER_AGENT = "Geckoboard-Ruby/#{VERSION}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geckoboard-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Upton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/geckoboard/dataset.rb
 - lib/geckoboard/datasets_client.rb
 - lib/geckoboard/errors.rb
+- lib/geckoboard/field_types.rb
 - lib/geckoboard/payload_formatter.rb
 - lib/geckoboard/version.rb
 homepage: https://github.com/geckoboard/geckoboard-ruby