irkit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e995782033d14e6589ddf02df38cf7eccb8fa9b
+  data.tar.gz: 43f37c11ae7a5c379c3b77be2203291196105de7
+SHA512:
+  metadata.gz: 60b51d5dbf004ab1ee1a7b9069ec6e1129c7d01863cf42d89c00084e90239416b86156222090322d6042cfafae6ab70d5fb3a7d059c6b28cba3fbce9ffa7ad96
+  data.tar.gz: c2cdb0d42918061cda7821c3dd858b726ac28dc5ff6a51b46980292352a42072e5df3654ffcfbded4f1bc184611f41ad4ac9bca43d1ec2ae52086ade715f54c3

data/.gitignore

@@ -0,0 +1,19 @@
+*~
+*#*
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2014-03-16
+
+* first release
+* Implemented IRKit::Device and IRKit::InternetAPI

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sho Hashimoto
+
+MIT License
+
+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,114 @@
+# IRKit
+
+[IRKit](http://getirkit.com) Client for Ruby
+
+
+## Requirements
+
+- Ruby2.0+
+- Mac OSX or Linux
+
+
+## Installation
+
+for Mac
+
+    % gem install irkit
+
+for Debian/Ubuntu Linux
+
+    % sudo apt-get install libavahi-compat-libdnssd-dev
+    % gem install irkit
+
+
+## Usage
+
+see [samples](https://github.com/shokai/ruby-irkit/tree/master/samples)
+
+### Read/Write IR-Data
+
+IRKit has a HTTP-API that can be used from within the same LAN.
+
+```ruby
+require 'irkit'
+
+# find IRKit with Bonjour
+irkit = IRKit::Device.find.first
+
+# or, specify with IP-Address
+# irkit = IRKit::Device.new(address: '192.168.0.123')
+
+unless irkit
+  STDERR.puts 'device not found'
+  exit 1
+end
+
+ir_data = irkit.get_messages
+unless ir_data
+  STDERR.puts 'IR data not found'
+  exit 1
+end
+
+p ir_data
+
+puts 'rewrite IR data'
+irkit.post_messages ir_data
+```
+
+
+### Internet-API
+
+To access IRKit from outside of the LAN, use Internet-API.
+It uses api.getirkit.com as a proxy.
+
+
+Get `clientkey` and `deviceid`
+
+```ruby
+irkit = IRKit::Device.find.first
+
+unless irkit
+  STDERR.puts 'device not found'
+  exit 1
+end
+
+token = irkit.get_token
+puts "token: #{token}"
+res = irkit.get_key_and_deviceid(token)
+
+puts "clientkey:#{res.clientkey}"
+puts "deviceid:#{res.deviceid}"
+```
+
+
+Read/Write with Internet-API
+
+```ruby
+irkit = IRKit::InternetAPI.new(clientkey: "your-clientkey", deviceid: "your-deviceid")
+
+unless irkit
+  STDERR.puts 'device not found'
+  exit 1
+end
+
+p irkit
+
+unless ir_data = irkit.get_messages
+  STDERR.puts 'IR data not found'
+  exit 1
+end
+
+p ir_data.message
+
+puts 'rewrite IR data'
+irkit.post_messages ir_data.message
+```
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_*.rb"
+end
+
+task :default => :test

data/irkit.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'irkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "irkit"
+  spec.version       = IRKit::VERSION
+  spec.authors       = ["Sho Hashimoto"]
+  spec.email         = ["hashimoto@shokai.org"]
+  spec.description   = %q{IRKit Client for Ruby}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/shokai/ruby-irkit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/).reject{|i| i=="Gemfile.lock" }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "dnssd"
+  spec.add_dependency "httparty"
+  spec.add_dependency "json"
+  spec.add_dependency "hashie"
+end

data/lib/irkit.rb

@@ -0,0 +1,16 @@
+require "socket"
+
+require "dnssd"
+require "httparty"
+require "json"
+require "hashie"
+
+require "irkit/version"
+require "irkit/error"
+require "irkit/response"
+require "irkit/device"
+require "irkit/find"
+require "irkit/internet_api"
+
+module IRKit
+end

data/lib/irkit/device.rb

@@ -0,0 +1,59 @@
+module IRKit
+  class Device
+
+    attr_accessor :address, :bonjour_name
+
+    def initialize(address: nil)
+      @address = address
+    end
+
+    def url
+      "http://#{@address}"
+    end
+
+    def get_messages
+      res = HTTParty.get("#{url}/messages")
+      case res.code
+      when 200
+        return nil if res.body.length < 1
+        return IRKit::Response.new JSON.parse res.body
+      else
+        raise IRKit::Error, res.body
+      end
+    end
+
+    def post_messages(data)
+      opts = {
+        :body => data.to_json
+      }
+      HTTParty.post "#{url}/messages", opts
+    end
+
+    def get_token
+      res = HTTParty.post "#{url}/keys", {}
+      case res.code
+      when 200
+        return JSON.parse(res.body)["clienttoken"]
+      else
+        raise IRKit::Error, res.body
+      end
+    end
+
+    def get_key_and_deviceid(clienttoken)
+      raise ArgumentError, "token must be String" unless clienttoken.kind_of? String
+      opts = {
+        :body => {
+          :clienttoken => clienttoken
+        }
+      }
+      res = HTTParty.post "http://api.getirkit.com/1/keys", opts
+      case res.code
+      when 200
+        return IRKit::Response.new JSON.parse(res.body)
+      else
+        raise IRKit::Error, res.body
+      end
+    end
+
+  end
+end

data/lib/irkit/error.rb

@@ -0,0 +1,4 @@
+module IRKit
+  class Error < StandardError
+  end
+end

data/lib/irkit/find.rb

@@ -0,0 +1,27 @@
+module IRKit
+
+  class Device
+
+    def self.find(&block)
+      hosts = []
+      DNSSD.browse '_irkit._tcp' do |reply|
+        next unless reply.name =~ /irkit/
+        addrs = Socket.getaddrinfo("#{reply.name}.local.", nil, Socket::AF_INET)
+        begin
+          device = IRKit::Device.new(address: addrs[0][2])
+          device.bonjour_name = reply.name
+          hosts.push device
+        rescue
+          next
+        end
+      end
+      5.times do
+        sleep 1
+        break unless hosts.empty?
+      end
+      return hosts
+    end
+
+  end
+
+end

data/lib/irkit/internet_api.rb

@@ -0,0 +1,50 @@
+module IRKit
+
+  class InternetAPI
+
+    attr_reader :clientkey, :deviceid
+
+    def initialize(clientkey: nil, deviceid: nil)
+      raise ArgumentError, "clientkey must be String" unless clientkey.kind_of? String
+      raise ArgumentError, "deviceid must be String" unless deviceid.kind_of? String
+      @clientkey = clientkey
+      @deviceid = deviceid
+    end
+
+    def url
+      "https://api.getirkit.com/1"
+    end
+
+    def get_messages(query={})
+      opts = {
+        :query => {:clientkey => @clientkey}
+      }
+      query.each do |k,v|
+        opts[:query][k] = v
+      end
+      res = HTTParty.get("#{url}/messages", opts)
+      case res.code
+      when 200
+        return nil if res.body.length < 1
+        return IRKit::Response.new JSON.parse res.body
+      when 401
+        raise IRKit::Error, "Unauthorized"
+      else
+        raise IRKit::Error, res.body
+      end
+    end
+
+    def post_messages(data)
+      opts = {
+        :body => {
+          :deviceid => @deviceid,
+          :clientkey => @clientkey,
+          :message => data.to_json
+        }
+      }
+      HTTParty.post "#{url}/messages", opts
+    end
+
+  end
+
+end

data/lib/irkit/response.rb

@@ -0,0 +1,6 @@
+module IRKit
+
+  class Response < ::Hashie::Mash
+  end
+
+end

data/lib/irkit/version.rb

@@ -0,0 +1,3 @@
+module IRKit
+  VERSION = "0.0.1"
+end

data/samples/get_clientkey_and_deviceid.rb

@@ -0,0 +1,15 @@
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+
+require 'irkit'
+
+unless irkit = IRKit::Device.find.first
+  STDERR.puts 'device not found'
+  exit 1
+end
+
+token = irkit.get_token
+puts "token:\t#{token}"
+res = irkit.get_key_and_deviceid(token)
+
+puts "clientkey:\t#{res.clientkey}"
+puts "deviceid:\t#{res.deviceid}"

data/samples/read_and_write.rb

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+
+require 'irkit'
+
+irkit = IRKit::Device.find.first
+# irkit = IRKit::Device.new(address: '192.168.1.112')
+unless irkit
+  STDERR.puts 'device not found'
+  exit 1
+end
+
+p irkit
+
+unless ir_data = irkit.get_messages
+  STDERR.puts 'IR data not found'
+  exit 1
+end
+
+p ir_data
+
+puts 'rewrite IR data'
+p irkit.post_messages ir_data

data/samples/read_and_write_internet_api.rb

@@ -0,0 +1,24 @@
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+
+require 'irkit'
+
+CLIENT_KEY = ENV["CLIENT_KEY"] || "your_client_key"
+DEVICE_ID  = ENV["DEVICE_ID"]  || "your_device_id"
+
+irkit = IRKit::InternetAPI.new(clientkey: CLIENT_KEY, deviceid: DEVICE_ID)
+unless irkit
+  STDERR.puts 'device not found'
+  exit 1
+end
+
+p irkit
+
+unless ir_data = irkit.get_messages
+  STDERR.puts 'IR data not found'
+  exit 1
+end
+
+p ir_data.message
+
+puts 'rewrite IR data'
+p irkit.post_messages ir_data.message

data/test/test_device.rb

@@ -0,0 +1,17 @@
+require File.expand_path 'test_helper', File.dirname(__FILE__)
+
+class TestDevice < MiniTest::Test
+
+  def setup
+    @device = IRKit::Device.find.first
+  end
+
+  def test_get_messages
+    res = @device.get_messages
+    assert_equal res.class, IRKit::Response
+    assert_equal res.format, "raw"
+    assert_equal res.freq, 38
+    assert_equal res.data.class, Array
+  end
+
+end

data/test/test_find.rb

@@ -0,0 +1,13 @@
+require File.expand_path 'test_helper', File.dirname(__FILE__)
+
+class TestFind < MiniTest::Test
+
+  def test_find
+    devices = IRKit::Device.find
+    assert_equal devices.class, Array
+    devices.each do |device|
+      assert_equal device.class, IRKit::Device
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/autorun'
+
+$:.unshift File.expand_path '../lib', File.dirname(__FILE__)
+require 'irkit'

data/test/test_token_key_deviceid.rb

@@ -0,0 +1,19 @@
+require File.expand_path 'test_helper', File.dirname(__FILE__)
+
+class TestTokenKeyDeviceID < MiniTest::Test
+
+  def test_token_key_deviceid
+    device = IRKit::Device.find.first
+    token = device.get_token
+    assert_equal token.class, String
+    assert token =~ /^[a-zA-Z\d]+$/, "token must be Hex String"
+
+    info = device.get_key_and_deviceid(token)
+    assert_equal info.class, IRKit::Response
+    assert_equal info.clientkey.class, String
+    assert info.clientkey =~  /^[a-zA-Z\d]+$/, "clientkey must be Hex String"
+    assert_equal info.deviceid.class, String
+    assert info.deviceid =~  /^[a-zA-Z\d]+$/, "deviceid must be Hex String"
+  end
+
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: irkit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sho Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: minitest
+  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: dnssd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: IRKit Client for Ruby
+email:
+- hashimoto@shokai.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- History.txt
+- LICENSE.txt
+- README.md
+- Rakefile
+- irkit.gemspec
+- lib/irkit.rb
+- lib/irkit/device.rb
+- lib/irkit/error.rb
+- lib/irkit/find.rb
+- lib/irkit/internet_api.rb
+- lib/irkit/response.rb
+- lib/irkit/version.rb
+- samples/get_clientkey_and_deviceid.rb
+- samples/read_and_write.rb
+- samples/read_and_write_internet_api.rb
+- test/test_device.rb
+- test/test_find.rb
+- test/test_helper.rb
+- test/test_token_key_deviceid.rb
+homepage: https://github.com/shokai/ruby-irkit
+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.0.14
+signing_key: 
+specification_version: 4
+summary: IRKit Client for Ruby
+test_files:
+- test/test_device.rb
+- test/test_find.rb
+- test/test_helper.rb
+- test/test_token_key_deviceid.rb