bothan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e74caa644e22a6466f31d416ea27e6e45cdcb92
+  data.tar.gz: c6e066328ad4532cd64fbb4e214cf6c9af8b5da8
+SHA512:
+  metadata.gz: 433e3bdd8d8ebe95b991532c6792236002e87c73a1edea5152d0b4ef15c664ee39a23d3cea12909bc78728ea04cc1234726110d737ae6753ad4b9a7b1bd02c8b
+  data.tar.gz: 837bd3d831fe32d403f3ecddd0c6f1dc479a8bd78495809d801cf2b801347e866e265f872fab719780f8e9e7ba45c19b606157bf2456519a81cc166332ea53ab

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+- 2.1.4
+before_install: gem install bundler -v 1.11.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: eK0WoXo122Y6i8+acj93cD/35YJt7UJy60WcwQwftyCsOuv7UFk+LgFrTrO/sKqPbLrIGn9LIXfXBAnEY9jufo33mcrhjE5fNxMnOG8L6iABVx5v3U2jec83eferEgyyLl5TXPHa1HiZjIg7MI1QpvYQD4lsvOuU2vrYuw96JdRohGsw4tT+LOyO060Ko0VCUHag/vRJY3mm3z2xRcsl3RtJL4xiYgOy2EpbTPzoEZUmaGnpY0THX6RjUYLJqW1ijvgHNPXFgKidKxdsJ/DE03bzl19tVrp+Jdk7uxwv7wWBuDv0B9msa51ZN0i2bw4zXCDUFzY8lTUp0dlULpBBu32V7Rnv3akW7TPHQyrwjLFVqRQEGEPXOI9aUFwi8ldSk/l8CDrQ7wZ/aBc1Kp8KBXV34NssRgMQnAhJZizVa6VwySPmFRKvKTamUcoYyYg6qR7p7T+KL1fJtq7cg5xbmCLkVwE9kWdhrcbprhnxQpS2xM2tyTjDi3XKh8E1VqqpbddmHEqShtnV2yN+ndL3WX/X8puDhhRnCaNfFY6sApsQ6gQGP3Gz93VdzYA0Jd0G3liVAR9qCxKrioDaZCQfGBVPU5BS52TDF0yO6tiZIf7c0q7mun9skAlrBcuQdESAvZLs9rvQ8Ymc7ytdw/0I46sUX3zFJEB8h6qhFwivBmg=
+  gem: bothan
+  on:
+    tags: true
+    repo: theodi/bothan.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at pezholio@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 pezholio
+
+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,178 @@
+# Bothan
+
+A Ruby client for [Bothan](https://bothan.io/), a simple platform for storing and publishing metrics.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bothan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bothan
+
+## Usage
+
+First require the Bothan client:
+
+```ruby
+require 'bothan'
+```
+
+Then initialize a connection with your username, password and the url of your Bothan endpoint:
+
+```ruby
+@bothan = Bothan::Connection.new('username', 'password', 'https://demo.bothan.io')
+```
+
+You will then be able to interact with your [Bothan API](https://bothan.io/api.html) via the `metrics` method like so:
+
+### Get all metrics
+
+Returns a list of available metrics as an array of hashes
+
+```ruby
+@bothan.metrics.all
+#=> [{"name"=>"metric-with-geodata", "url"=>"https://demo.bothan.io/metrics/metric-with-geodata.json"}, {"name"=>"metric-with-multiple-values", "url"=>"https://demo.bothan.io/metrics/metric-with-multiple-values.json"}, {"name"=>"metric-with-target", "url"=>"https://demo.bothan.io/metrics/metric-with-target.json"}, {"name"=>"metric-with-ytd-target", "url"=>"https://demo.bothan.io/metrics/metric-with-ytd-target.json"},{"name"=>"simple-metric", "url"=>"https://demo.bothan.io/metrics/simple-metric.json"}]
+```
+
+### Find a metric
+
+#### Latest value
+
+Returns the latest value for a specified metric as a hash
+
+```ruby
+@bothan.metrics.find('simple-metric')
+#=> {"_id"=>{"$oid"=>"58451086db72110004125f6d"}, "name"=>"simple-metric", "time"=>"2016-12-05T07:00:22.459+00:00", "value"=>68}
+```
+
+#### For a specific DateTime
+
+Returns the most recent value of a metric at the specified datetime.
+
+```ruby
+@bothan.metrics.find('simple-metric', '2016-12-05T07:00:22.459+00:00')
+#=> {"_id"=>{"$oid"=>"58451086db72110004125f6d"}, "name"=>"simple-metric", "time"=>"2016-12-05T07:00:22.459+00:00", "value"=>68}
+```
+
+#### For a specific DateTime range
+
+Returns all values of the metric between the specified times.
+
+```ruby
+@bothan.metrics.find('simple-metric', '2016-12-01T07:00:22.851+00:00', '2016-12-05T07:00:22.459+00:00')
+#=> [{"time"=>"2016-12-01T07:00:22.851+00:00", "value"=>92}, {"time"=>"2016-12-02T07:00:22.759+00:00", "value"=>17}, {"time"=>"2016-12-03T07:00:22.664+00:00", "value"=>18}, {"time"=>"2016-12-04T07:00:22.569+00:00", "value"=>12}, {"time"=>"2016-12-05T07:00:22.459+00:00", "value"=>68}]
+```
+
+The `from` and `to` values can be either:
+
+* An ISO8601 date/time
+* A Ruby DateTime object
+* An [ISO8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations)
+* \*, meaning unspecified
+
+### Create a metric
+
+The Bothan API supports four types of metric, all supported by the gem.
+
+#### Create a [simple metric](https://bothan.io/api#simple-value)
+
+```ruby
+# Create a metric called 'my-new-metric' with a value of '12' at the current datetime
+@bothan.metrics.create('my-new-metric', 12)
+# Create a metric with a specific datetime
+@bothan.metrics.create('my-new-metric', 12, '2016-01-01T00:00:00')
+```
+
+#### Create a [metric with a target](https://bothan.io/api#value-with-a-target)
+
+```ruby
+# Create a metric called 'my-new-metric' with a value of '1091000', an annual target of '2862000' and a ytd target of '1368000' at the current datetime
+@bothan.metrics.create_target('my-new-target-metric', 1091000, 2862000, 1368000)
+# Create a metric with a target at a specific datetime
+@bothan.metrics.create_target('my-new-target-metric', 1091000, 2862000, 1368000, '2016-01-01T00:00:00')
+# Create a metric without a ytd target
+@bothan.metrics.create_target('my-new-target-metric', 1091000, 2862000)
+# Create a metric without a ytd target at a specific datetime
+@bothan.metrics.create_target('my-new-target-metric', 1091000, 2862000, nil, '2016-01-01T00:00:00')
+```
+
+#### Create a [metric with multiple values](https://bothan.io/api#multiple-values)
+
+```ruby
+# Create a metric called 'my-new-metric' with multiple values with the current datetime
+@bothan.metrics.create_multiple('my-awesome-mulitple-metric', {
+  "value1" => 123,
+  "value2" => 23213,
+  "value4" => 1235
+})
+# Create a metric called 'my-new-metric' with multiple values with a specific datetime
+@bothan.metrics.create_multiple('my-awesome-mulitple-metric', {
+  "value1" => 123,
+  "value2" => 23213,
+  "value4" => 1235
+}, "2016-11-28T09:00:00")
+```
+
+#### Create a [metric with geodata](https://bothan.io/api#geographical-data)
+
+```ruby
+# Create a geodata metric called 'my-new-metric' with the current datetime
+@bothan.metrics.create_geo('my-new-metric', [
+  {
+    "type" => "Feature",
+    "geometry" => {
+      "type" => "Point",
+      "coordinates" => [-2.6156582783015017, 54.3497405310758]
+    }
+  },
+  {
+    "type" => "Feature",
+    "geometry" => {
+      "type" => "Point",
+       "coordinates" => [-6.731370299641439, 55.856756177781186]
+    }
+  }
+])
+# Create a geodata metric called 'my-new-metric' with a specific datetime
+@bothan.metrics.create_geo('my-awesome-geo-metric', [
+  {
+    "type" => "Feature",
+    "geometry" => {
+      "type" => "Point",
+      "coordinates" => [-2.6156582783015017, 54.3497405310758]
+    }
+  },
+  {
+    "type" => "Feature",
+    "geometry" => {
+      "type" => "Point",
+       "coordinates" => [-6.731370299641439, 55.856756177781186]
+    }
+  }
+], "2016-11-28T09:00:00")
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bothan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+ 

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bothan"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bothan.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bothan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bothan"
+  spec.version       = Bothan::VERSION
+  spec.authors       = ["pezholio"]
+  spec.email         = ["pezholio@gmail.com"]
+
+  spec.summary       = "A Ruby client library for Bothan - https://bothan.io"
+  spec.homepage      = "https://github.com/theodi/bothan.rb."
+  spec.license       = "MIT"
+
+  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 = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.14.0"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0.3"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+end

data/lib/bothan.rb

@@ -0,0 +1,11 @@
+require "uri"
+require "httparty"
+
+require "bothan/version"
+require "bothan/errors"
+require "bothan/connection"
+require "bothan/metrics"
+
+module Bothan
+  # Your code goes here...
+end

data/lib/bothan/connection.rb

@@ -0,0 +1,13 @@
+module Bothan
+  class Connection
+
+    def initialize(username, password, endpoint)
+      @username, @password, @endpoint = username, password, endpoint
+    end
+
+    def metrics
+      @metrics ||= Metrics.new(@username, @password, @endpoint)
+    end
+
+  end
+end

data/lib/bothan/errors.rb

@@ -0,0 +1,3 @@
+module Bothan
+  class MetricNotFound < StandardError; end
+end

data/lib/bothan/metrics.rb

@@ -0,0 +1,71 @@
+module Bothan
+  class Metrics
+    include HTTParty
+    headers 'Accept' => 'application/json'
+
+    def initialize(username, password, endpoint)
+      self.class.base_uri endpoint
+      self.class.basic_auth username, password
+    end
+
+    def all
+      (self.class.get('/metrics').parsed_response || {})['metrics']
+    end
+
+    def find(metric, from = nil, to = nil)
+      if from.nil? && to.nil?
+        metric = self.class.get("/metrics/#{metric}").parsed_response
+      elsif !from.nil? && to.nil?
+        metric = self.class.get("/metrics/#{metric}/#{from}").parsed_response
+      elsif !from.nil? && !to.nil?
+        metric = self.class.get("/metrics/#{metric}/#{from}/#{to}").parsed_response
+      end
+      raise MetricNotFound if metric.nil?
+      metric['count'] ? metric['values'] : metric
+    end
+
+    def create_single(name, value, time = DateTime.now)
+      create_metric(name, value, time)
+    end
+
+    alias_method :create, :create_single
+
+    def create_target(name, actual, annual_target, ytd_target = nil, time = DateTime.now)
+      value = {
+        actual: actual,
+        annual_target: annual_target,
+        ytd_target: ytd_target
+      }.delete_if { |k, v| v.nil? }
+
+      create_metric(name, value, time)
+    end
+
+    def create_multiple(name, values, time = DateTime.now)
+      value = {
+        total: values
+      }
+
+      create_metric(name, value, time)
+    end
+
+    def create_geo(name, features, time = DateTime.now)
+      value = {
+        type: "FeatureCollection",
+        features: features
+      }
+
+      create_metric(name, value, time)
+    end
+
+    private
+
+      def create_metric(name, value, time = DateTime.now)
+        json = {
+          time: time.to_s,
+          value: value
+        }.to_json
+        self.class.post("/metrics/#{name}", body: json, headers: { 'Content-Type' => 'application/json' } )
+      end
+
+  end
+end

data/lib/bothan/version.rb

@@ -0,0 +1,3 @@
+module Bothan
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: bothan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pezholio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email:
+- pezholio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bothan.gemspec
+- lib/bothan.rb
+- lib/bothan/connection.rb
+- lib/bothan/errors.rb
+- lib/bothan/metrics.rb
+- lib/bothan/version.rb
+homepage: https://github.com/theodi/bothan.rb.
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby client library for Bothan - https://bothan.io
+test_files: []