geckoboard-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 911c6fae3e14c01c56dcee219a1a0a36ea7f6c8f
+  data.tar.gz: e3d5e9c25f948e6c650feb253fc724c78860b2e6
+SHA512:
+  metadata.gz: de07437d8fec724846db64021ea804a0973cf688b1da0a2292612bc3b43e7e68be5715f6f18ac8911afdb09cb665e9d7579f88b47fff8269bd925a9669b5d8bc
+  data.tar.gz: 7bbaa3a2567654fe4ead80bc105d53fcd2b2a0d9bbbd582fdaa0b09fff821d3bfa5d5486d2d57e116b9f1a85b1683721217563b40b92ec9e9d2a5d496577ff30

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in geckoboard-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Geckoboard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# 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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geckoboard-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geckoboard-ruby
+
+## Usage
+
+### Ping to authenticate
+
+Verify that your API key is valid and that you can reach the Geckoboard API.
+
+```ruby
+client = Geckoboard.client('222efc82e7933138077b1c2554439e15')
+client.ping # => true
+```
+
+### Find or create
+
+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'
+  }
+})
+```
+
+### Delete
+
+Delete a dataset and all data therein.
+
+```ruby
+dataset.delete # => true
+```
+
+Delete a dataset with a given id.
+
+```ruby
+client.datasets.delete('sales.gross') # => true
+```
+
+### Put
+
+Replace all data in the dataset.
+
+```ruby
+dataset.put([
+  {
+    timestamp: DateTime.new(2016, 1, 2, 12, 0, 0),
+    amount: 409
+  },
+  {
+    timestamp: DateTime.new(2016, 1, 3, 12, 0, 0),
+    amount: 164
+  },
+])
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/geckoboard/geckoboard-ruby/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geckoboard"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.3.1

data/geckoboard-ruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geckoboard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'geckoboard-ruby'
+  spec.version       = Geckoboard::VERSION
+  spec.authors       = ['Daniel Upton']
+  spec.email         = %w[daniel.upton@geckoboard.com]
+
+  spec.summary       = %q{Ruby client library for Geckoboard}
+  spec.homepage      = 'https://github.com/geckoboard/geckoboard-ruby'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

data/lib/geckoboard.rb

@@ -0,0 +1,19 @@
+require 'net/http'
+require 'json'
+require 'cgi'
+
+require 'geckoboard/version'
+require 'geckoboard/connection'
+require 'geckoboard/client'
+require 'geckoboard/datasets_client'
+require 'geckoboard/dataset'
+require 'geckoboard/payload_formatter'
+require 'geckoboard/errors'
+
+module Geckoboard
+  USER_AGENT = "Geckoboard-Ruby/#{VERSION}"
+
+  def self.client(api_key)
+    Client.new(api_key)
+  end
+end

data/lib/geckoboard/client.rb

@@ -0,0 +1,18 @@
+module Geckoboard
+  class Client
+    attr_reader :connection
+
+    def initialize(api_key)
+      @connection = Connection.new(api_key)
+    end
+
+    def ping
+      connection.get('/')
+      true
+    end
+
+    def datasets
+      DatasetsClient.new(connection)
+    end
+  end
+end

data/lib/geckoboard/connection.rb

@@ -0,0 +1,74 @@
+module Geckoboard
+  class Connection
+    attr_reader :api_key
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def get(path)
+      request = Net::HTTP::Get.new(path)
+
+      make_request(request)
+    end
+
+    def delete(path)
+      request = Net::HTTP::Delete.new(path)
+
+      make_request(request)
+    end
+
+    def put(path, body)
+      request = Net::HTTP::Put.new(path)
+      request['Content-Type'] = 'application/json'
+      request.body = body
+
+      make_request(request)
+    end
+
+    private
+
+    def make_request(request)
+      request.basic_auth(api_key, '')
+      request['User-Agent'] = USER_AGENT
+
+      response = http.request(request)
+      check_for_errors(response)
+      response
+    end
+
+    def check_for_errors(response)
+      return if response.code.to_i < 400
+
+      error_message = extract_error_message(response) ||
+        "Server responded with unexpected status code (#{response.code})"
+
+      exception = case response
+                  when Net::HTTPUnauthorized then UnauthorizedError
+                  when Net::HTTPConflict     then ConflictError
+                  when Net::HTTPBadRequest   then BadRequestError
+                  else UnexpectedStatusError
+                  end
+
+      raise exception, error_message
+    end
+
+    def extract_error_message(response)
+      return unless response_is_json? response
+
+      JSON.parse(response.body)
+        .fetch('error', {})
+        .fetch('message', nil)
+    end
+
+    def response_is_json?(response)
+      (response['Content-Type'] || '').split(';').first == 'application/json'
+    end
+
+    def http
+      http = Net::HTTP.new('api.geckoboard.com', 443)
+      http.use_ssl = true
+      http
+    end
+  end
+end

data/lib/geckoboard/dataset.rb

@@ -0,0 +1,25 @@
+module Geckoboard
+  class Dataset
+    attr_reader :client, :id, :fields
+
+    def initialize(client, id, fields)
+      @client = client
+      @id     = id
+      @fields = fields
+    end
+
+    def delete
+      client.delete(id)
+    end
+
+    def put(data)
+      client.put_data(id, payload_formatter.format(data))
+    end
+
+    private
+
+    def payload_formatter
+      PayloadFormatter.new(self)
+    end
+  end
+end

data/lib/geckoboard/datasets_client.rb

@@ -0,0 +1,35 @@
+module Geckoboard
+  class DatasetsClient
+    attr_reader :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def find_or_create(dataset_id, fields: {})
+      path = dataset_path(dataset_id)
+      response = connection.put(path, { fields: fields }.to_json)
+
+      data = JSON.parse(response.body)
+      Dataset.new(self, data.fetch('id'), data.fetch('fields'))
+    end
+
+    def delete(dataset_id)
+      path = dataset_path(dataset_id)
+      connection.delete(path)
+      true
+    end
+
+    def put_data(dataset_id, data)
+      path = "#{dataset_path(dataset_id)}/data"
+      connection.put(path, { data: data }.to_json)
+      true
+    end
+
+    private
+
+    def dataset_path(dataset_id)
+      "/datasets/#{CGI.escape(dataset_id)}"
+    end
+  end
+end

data/lib/geckoboard/errors.rb

@@ -0,0 +1,7 @@
+module Geckoboard
+  BaseError             = Class.new(StandardError)
+  BadRequestError       = Class.new(BaseError)
+  ConflictError         = Class.new(BaseError)
+  UnauthorizedError     = Class.new(BaseError)
+  UnexpectedStatusError = Class.new(BaseError)
+end

data/lib/geckoboard/payload_formatter.rb

@@ -0,0 +1,46 @@
+module Geckoboard
+  class PayloadFormatter
+    attr_reader :dataset
+
+    def initialize(dataset)
+      @dataset = dataset
+    end
+
+    def format(payload)
+      payload.map do |item|
+        item.inject({}) do |hash, (field_name, value)|
+          field_name = field_name.to_s
+
+          value = case field_type(field_name)
+                  when 'date'     then format_date(value)
+                  when 'datetime' then format_datetime(value)
+                  else
+                    value
+                  end
+
+          hash.merge(field_name => value)
+        end
+      end
+    end
+
+    private
+
+    def field_type(name)
+      @field_types ||= dataset.fields.inject({}) do |hash, (field_name, definition)|
+        hash.merge(field_name => definition.fetch('type'))
+      end
+
+      @field_types.fetch(name, 'string')
+    end
+
+    def format_date(value)
+      return value unless value.respond_to? :strftime
+      value.strftime('%Y-%m-%d')
+    end
+
+    def format_datetime(value)
+      return value unless value.respond_to? :strftime
+      value.strftime('%Y-%m-%dT%H:%M:%S%:z')
+    end
+  end
+end

data/lib/geckoboard/version.rb

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

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: geckoboard-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Upton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email:
+- daniel.upton@geckoboard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- geckoboard-ruby.gemspec
+- lib/geckoboard.rb
+- lib/geckoboard/client.rb
+- lib/geckoboard/connection.rb
+- lib/geckoboard/dataset.rb
+- lib/geckoboard/datasets_client.rb
+- lib/geckoboard/errors.rb
+- lib/geckoboard/payload_formatter.rb
+- lib/geckoboard/version.rb
+homepage: https://github.com/geckoboard/geckoboard-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Ruby client library for Geckoboard
+test_files: []
+has_rdoc: