ruby-ambient 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86bd069eeb4b8253e91441e6015e798f43a2a505cb840b731acd6d9c9183b0cb
+  data.tar.gz: ac440460aba33680beae072b40964159457a7884451e17de8f4c627b504fc351
+SHA512:
+  metadata.gz: 45abaa5971bc905c6a6a0b9a74ea1fea9679f28013bc46c74c2a6e72451dc819a6eab963c20ed3f9ec81e5d8dbd3da012986a2586642c3398e74f1edba150e2b
+  data.tar.gz: 2d8ee417ee30284431358d59769ef0f680a1b0d486dfd31a9b45f1f42e5f2661d2a7f17dd9f7d8856d0fa1ac5a433ce046b2d50fd3ae854e34d569606488176e

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0 (2020/07/18)
+
+- First release

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    ruby-ambient (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  ruby-ambient!
+
+BUNDLED WITH
+   2.1.2

data/README.md

@@ -0,0 +1,124 @@
+# Ruby::Ambient
+
+A simple library that calls Ambient's API, which can be used similarly to [official python library](https://github.com/AmbientDataInc/ambient-python-lib)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-ambient'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby-ambient
+
+## Usage
+
+### Send sensor data to Ambient
+
+`write_key` is required. Set it when you create the ambient instance, or set it from accessor.
+
+```ruby
+am = Ambient.new('12345', write_key: '1234567890abcdef')
+p am.send({d1: 1.03, d2: 2.2})
+# => #<Net::HTTPOK 200 OK readbody=true>
+```
+
+```ruby
+am = Ambient.new('12345')
+am.write_key = '1234567890abcdef'
+am.send([
+  { created: '2020/7/18 20:21:19', d1: 2.3, d2: 3.8 },
+  { created: '2020/7/18 20:21:20', d1: 2.1, d2: 3.1 },
+])
+```
+
+### Receive sensor data from Ambient
+
+`read_key` is required. Set it when you create the ambient instance, or set it from accessor.
+
+```ruby
+require 'pp'
+am = Ambient.new('12345', read_key: '1234567890abcdef')
+pp am.read()
+
+# => 
+# [{:d1=>1.1, :d2=>2.1, :created=>"2017-02-18T03:00:00.000Z"},
+#  {:d1=>1.5, :d2=>3.8, :created=>"2017-02-18T03:01:00.000Z"},
+#  {:d1=>1, :d2=>0.8, :created=>"2017-02-18T03:02:00.000Z"},
+#  {:d1=>2.3, :d2=>3.8, :created=>"2020-07-16T11:21:19.000Z"},
+#  {:d1=>2.1, :d2=>3.1, :created=>"2020-07-16T11:21:20.000Z"},
+#  {:d1=>1.1, :d2=>2.1, :created=>"2020-07-18T07:00:00.000Z"},
+#  {:d1=>1.1, :d2=>2.1, :created=>"2020-07-18T07:00:00.000Z"},
+#  {:d1=>1.5, :d2=>3.8, :created=>"2020-07-18T07:01:00.000Z"},
+#  {:d1=>1.5, :d2=>3.8, :created=>"2020-07-18T07:01:00.000Z"},
+#  {:d1=>1, :d2=>0.8, :created=>"2020-07-18T07:02:00.000Z"},
+#  {:d1=>1, :d2=>0.8, :created=>"2020-07-18T07:02:00.000Z"},
+#  {:d1=>1, :d2=>2, :created=>"2020-07-18T08:43:33.240Z"},
+#  {:d1=>1, :d2=>2, :created=>"2020-07-18T12:31:18.886Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:21:13.917Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:21:26.165Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:21:57.722Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:22:23.619Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:23:03.688Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:24:04.937Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:26:25.843Z"}]
+```
+
+If you want to specify a date, set the `date`.
+The format of the date is `YYYY-mm-dd` or `YYYY/mm/dd`.
+
+
+```ruby
+require 'pp'
+am = Ambient.new('12345', read_key: '1234567890abcdef')
+pp am.read(date: '2017-2-18')
+
+# => 
+# [{:d1=>1.1, :d2=>2.1, :created=>"2017-02-18T03:00:00.000Z"},
+#  {:d1=>1.5, :d2=>3.8, :created=>"2017-02-18T03:01:00.000Z"},
+#  {:d1=>1, :d2=>0.8, :created=>"2017-02-18T03:02:00.000Z"}]
+```
+
+If you want to specify the period, set `start` and `end`.
+The time zone of the date is `JST`.
+
+```ruby
+require 'pp'
+am = Ambient.new('12345', read_key: '1234567890abcdef')
+pp am.read(start: '2020-07-18 22:20:00', end: '2020-07-18 22:25:00')
+
+# => 
+# [{:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:21:13.917Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:21:26.165Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:21:57.722Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:22:23.619Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:23:03.688Z"},
+#  {:d1=>1.03, :d2=>2.2, :created=>"2020-07-18T13:24:04.937Z"}]
+```
+
+### Receive channel information
+
+`read_key` is required. Set it when you create the ambient instance, or set it from accessor.
+
+```ruby
+require 'pp'
+am = Ambient.new('12345', read_key: '1234567890abcdef')
+pp am.prop()
+
+# =>
+# {:ch=>"12345",
+#  :user=>"1234",
+#  ...
+# }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/suruseas/ruby-ambient.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/examples/prop.rb

@@ -0,0 +1,5 @@
+require 'ruby-ambient'
+
+am = Ambient.new('channel_id', read_key: 'dummy', write_key: 'dummy')
+
+pp am.prop

data/examples/read.rb

@@ -0,0 +1,5 @@
+require 'ruby-ambient'
+
+am = Ambient.new('channel_id', read_key: 'dummy', write_key: 'dummy')
+
+pp am.read

data/examples/send.rb

@@ -0,0 +1,5 @@
+require 'ruby-ambient'
+
+am = Ambient.new('channel_id', read_key: 'dummy', write_key: 'dummy')
+
+p am.send({d1: 1, d2: 2})

data/lib/ambient/version.rb

@@ -0,0 +1,3 @@
+class Ambient
+  VERSION = "0.1.0"
+end

data/lib/ruby-ambient.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+require "ambient/version"
+
+require 'net/http'
+require 'json'
+
+# This class is for communicating with Ambient API.
+class Ambient
+  attr_reader :channel_id
+  attr_accessor :write_key, :read_key, :user_key
+
+  BASE_URL = 'http://ambidata.io/api/v2/channels/%s'
+
+  # Create instance.
+  # 
+  # @param [String] channel_id Channel ID for Ambient.
+  # @option args [String] :write_key used when sending data.
+  # @option args [String] :read_key used when receiving and getting prop.
+  # @option args [String] :user_key unused
+  def initialize(channel_id, **args)
+    @channel_id = channel_id
+    @base_url = BASE_URL % @channel_id
+
+    @write_key = args[:write_key]
+    @read_key = args[:read_key]
+    @user_key = args[:user_key]
+  end
+
+  # Send sensor data to Ambient.
+  #
+  # @param [Object] data Hash or Array of Hash.
+  # @return [Net::HTTPResponse]
+  def send(data)
+    data = ([] << data).flatten
+    headers = { 'Content-Type': 'application/json' }
+    uri = URI.parse("#{@base_url}/dataarray")
+
+    post(uri, { writeKey: @write_key, data: data }.to_json, headers)
+  end
+
+  # Receive sensor data from Ambient.
+  #
+  # @option args [String] :date used when sending data
+  # @option args [String] :start used when receiving and getting prop
+  # @option args [String] :end unused
+  # @option args [String] :n Specify the number of data to be read. The latest [:n] data are read.
+  # @option args [String] :skip Available only when the N option is enabled. It skips the latest recent data and reads the [n] data after that.
+  # @return [Array<Hash>] It skips [:skip] of the latest data and reads [:n] of the latest data after that.
+  def read(**args)
+    args = self.class.symbolize_keys(args)
+
+    opt = {}
+    opt[:readKey] = @read_key if @read_key
+
+    if args.key?(:date)
+      opt[:date] = args[:date]
+    elsif args.key?(:start) && args.key?(:end)
+      opt[:start] = args[:start]
+      opt[:end] = args[:end]
+    elsif args.key?(:n)
+      opt[:n] = args[:n]
+      opt[:skip] = args[:skip] if args.key?(:skip)
+    end
+
+    url = "#{@base_url}/data"
+    url += '?' + opt.to_a.map { |k, v| "#{k}=#{v}" }.join('&') unless opt.empty?
+    uri = URI.parse(url)
+
+    res = JSON.parse(get(uri), symbolize_names: true)
+    Array.new(res).reverse
+  end
+
+  # Receive channel information
+  #
+  # @return [Array<Hash>]
+  def prop
+    @prop ||= begin
+      url = @base_url
+      url += "?readKey=#{@read_key}" if @read_key
+      uri = URI.parse(url)
+      JSON.parse(get(uri), symbolize_names: true)
+    end
+  end
+
+  class << self
+    def symbolize_keys(hash)
+      return hash unless hash&.is_a?(Hash)
+
+      hash.map do |k, v|
+        [
+          k.to_sym,
+          case v
+          when Hash
+            symbolize_keys(v)
+          when Array
+            v.each { |obj| symbolize_keys(obj) }
+          else
+            v
+          end
+        ]
+      end.to_h
+    end
+  end
+
+  private
+
+  def post(uri, payload, headers = {})
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.post(uri.path, payload, headers)
+  end
+
+  def get(uri)
+    Net::HTTP.get(uri)
+  end
+end

data/ruby-ambient.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/ambient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-ambient"
+  spec.version       = Ambient::VERSION
+  spec.authors       = ["yukihiro amadatsu"]
+  spec.email         = ["suruseas@gmail.com"]
+
+  spec.summary       = %q{A simple library for using the Ambient API.}
+  spec.description   = %q{A RubyGem library that can be used like the official python library}
+  spec.homepage      = "https://github.com/suruseas/ruby-ambient"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/suruseas/ruby-ambient"
+  spec.metadata["changelog_uri"] = "https://github.com/suruseas/ruby-ambient/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ruby-ambient
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yukihiro amadatsu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-18 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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'
+description: A RubyGem library that can be used like the official python library
+email:
+- suruseas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- examples/prop.rb
+- examples/read.rb
+- examples/send.rb
+- lib/ambient/version.rb
+- lib/ruby-ambient.rb
+- ruby-ambient.gemspec
+homepage: https://github.com/suruseas/ruby-ambient
+licenses: []
+metadata:
+  homepage_uri: https://github.com/suruseas/ruby-ambient
+  source_code_uri: https://github.com/suruseas/ruby-ambient
+  changelog_uri: https://github.com/suruseas/ruby-ambient/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A simple library for using the Ambient API.
+test_files: []