brunt_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18c32c1169c48c012604e9c9518fb9eda9e0a2ac3d96d6472fff6e3cb1745c2c
+  data.tar.gz: 86f73a0a50cd84ffb317323785b56bbb4b4ca39a06592344e8967597feb35135
+SHA512:
+  metadata.gz: 3e3d60081ebfd796ef6f16c825daef25e7d39475a479c0fd44f3ae43aea65d5231c449ee136b07df157636f6604cf6f2f80d8eacc0a18d1c83b88e6f69ab99f3
+  data.tar.gz: 7ba348cff7975e32a9cecee84d497077748e03985342274ee015d3de7a4e79093bdc5434e5b7e2e75cbbf04a83b828bc7f9a3ef281f2399dca4339492294f80e

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in brunt_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 mmck328
+
+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,49 @@
+# BruntAPI
+
+This is an unofficial Ruby binding for Brunt API. Ported from [JS binding by MattJeanes](https://github.com/MattJeanes/brunt-api).
+
+Currently this gem support operations only for Brunt Blind Engine.
+
+## Installation
+
+```ruby
+gem 'brunt_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brunt_api
+
+## Usage
+### Preparation
+```ruby
+client = BruntAPI::Client.new
+client.login('brunt_account_id', 'password')
+```
+### Get things infomation
+```ruby
+client.get_things
+```
+### Get thing state
+```ruby
+client.get_state('thing_uri')
+```
+`'thing_uri'` can be obtained by `BruntAPI::Client#get_things`.
+
+### Set blind position via Blind Engine
+```ruby
+client.set_position('thing_uri', position)
+```
+`position` must be `Numeric` in range 0-100.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mmck328/brunt_api.rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brunt_api"
+
+# 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(__FILE__)

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/brunt_api.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "brunt_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "brunt_api"
+  spec.version       = BruntAPI::VERSION
+  spec.authors       = ["mmck328"]
+  spec.email         = ["edamame1010@hotmail.co.jp"]
+
+  spec.summary       = "An unofficial Ruby binding for Brunt API (e.g. Blind Engine)"
+  spec.description   = "This is an unofficial Ruby binding of Brunt API (e.g. Blind Engine). Ported from JS binding by MattJeanes https://github.com/MattJeanes/brunt-api"
+  spec.homepage      = "https://github.com/mmck328/brunt_api.rb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "faraday", "~> 0.15.4"
+  spec.add_dependency "faraday_middleware", "~> 0.12.2"
+  spec.add_dependency "faraday-cookie_jar", "~> 0.0.6"
+end

data/lib/brunt_api.rb

@@ -0,0 +1,6 @@
+require "brunt_api/version"
+require "brunt_api/client"
+
+module BruntAPI
+  # Your code goes here...
+end

data/lib/brunt_api/client.rb

@@ -0,0 +1,98 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday-cookie_jar'
+require 'json'
+require 'brunt_api/error'
+
+module BruntAPI
+  class Client
+    def initialize
+      @conn = Faraday.new do |faraday|
+        faraday.request :json
+        faraday.use :cookie_jar
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def login(username, password)
+      res = @conn.post do |req|
+        req.url 'https://sky.brunt.co/session'
+        req.body = { ID: username, PASS: password }
+      end
+
+      if res.success?
+        JSON.parse(res.body)
+      else
+        handle_failed_response(res, 'Failed to login.')
+      end
+    end
+
+    def get_things
+      res = @conn.get do |req|
+        req.url 'https://sky.brunt.co/thing'
+      end
+
+      if res.success?
+        JSON.parse(res.body)
+      else
+        handle_failed_response(res, 'Failed to get things.')
+      end
+    end
+
+    def get_state(thing_uri)
+      res = @conn.get do |req|
+        req.url 'https://thing.brunt.co/thing' + thing_uri
+      end
+
+      if res.success?
+        JSON.parse(res.body)
+      else
+        handle_failed_response(res, 'Failed to get state of thing.')
+      end
+    end
+
+    def set_position(thing_uri, position)
+      unless position.kind_of?(Numeric)
+        raise ArgumentError, 'Position must be Numeric.'
+      end
+      if position.kind_of?(Complex)
+        raise ArgumentError, 'Position must not be Complex.'
+      end
+      if position < 0 or position > 100
+        raise ArgumentError, 'Position must be in range (0.0..100.0).'
+      end
+
+      res = @conn.put do |req|
+        req.url 'https://thing.brunt.co/thing' + thing_uri
+        req.body = { requestPosition: position.to_f.to_s }
+      end
+
+      if res.success?
+        begin
+          JSON.parse(res.body)
+        rescue
+          'success'
+        end
+      else
+        handle_failed_response(res, 'Failed to set position of thing.')
+      end
+    end
+
+    
+    private
+    def handle_failed_response(res, default_message)
+      case res.status
+      when 401
+        raise BruntAPI::UnauthorizedError
+      when 403
+        raise BruntAPI::ForbiddenError
+      when 404
+        raise BruntAPI::NotFoundError
+      when 503
+        raise BruntAPI::ServiceUnavailableError
+      else
+        raise BruntAPI::ClientError, default_message + " (API response status: #{res.status})"
+      end
+    end
+  end
+end

data/lib/brunt_api/error.rb

@@ -0,0 +1,28 @@
+module BruntAPI
+  class ClientError < StandardError
+  end
+
+  class UnauthorizedError < ClientError
+    def initialize
+      super('Unauthorized or authorization expired. Login and retry.')
+    end
+  end
+
+  class ForbiddenError < ClientError
+    def initialize
+      super('Access forbidden.')
+    end
+  end
+
+  class NotFoundError < ClientError
+    def initialize
+      super('Resource not found.')
+    end
+  end
+
+  class ServiceUnavailableError < ClientError
+    def initialize
+      super('API is currently unavailable.')
+    end
+  end
+end

data/lib/brunt_api/version.rb

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: brunt_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mmck328
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: faraday-cookie_jar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: This is an unofficial Ruby binding of Brunt API (e.g. Blind Engine).
+  Ported from JS binding by MattJeanes https://github.com/MattJeanes/brunt-api
+email:
+- edamame1010@hotmail.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brunt_api.gemspec
+- lib/brunt_api.rb
+- lib/brunt_api/client.rb
+- lib/brunt_api/error.rb
+- lib/brunt_api/version.rb
+homepage: https://github.com/mmck328/brunt_api.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.7.7
+signing_key: 
+specification_version: 4
+summary: An unofficial Ruby binding for Brunt API (e.g. Blind Engine)
+test_files: []