sesame_os2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f0b5a4520bdeff026e38159f0fffa40e1e42a850b6916550a918039a795881f
+  data.tar.gz: 46ffb7e94ab10675aa007675a2771ea327eb766e730fdb12b400bcffa4b1c09c
+SHA512:
+  metadata.gz: 12182699f5c1ef7801a5a3c7b1680804fa153b3f58d920c8f66c174bca54ec2ed5334a33a12ce5691eb42b6678a0088f90818d67ec403bdbb105291739d47a55
+  data.tar.gz: 5280dd825cbd6cdf60657e8474523045d475c4c5970edf4c44809cf28796a11d05891605f0b77bdedd41358b68c691d398dce39bccf97bdf51c6b4cb90e2eee3

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+Dockerfile
+docker-compose.yml
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sesame_os2.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"

data/README.md

@@ -0,0 +1,123 @@
+# SesameOs2
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sesame_os2`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+This gem is wrapper for using with sesame web api with ruby(sesame3, sesame4).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sesame_os2'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sesame_os2
+
+## Usage
+
+- Set environment variables
+  - SESAME_API_KEY
+  - SESAME_SSM
+
+```ruby
+client = SesameOs2::Client.new(name: 'webapi')
+```
+
+It can also be set with arguments.
+
+```ruby
+sesame_api_key = 'your api key'
+sesame_ssm = 'youse sesame ssm'
+
+client =
+  SesameOs2::Client.new(
+    name: 'webapi',
+    api_key: sesame_api_key,
+    ssm: sesame_ssm
+  )
+```
+
+### status
+
+```ruby
+client.status
+=>
+{"batteryPercentage"=>100,
+ "batteryVoltage"=>6.095014662756598,
+ "position"=>223,
+ "CHSesame2Status"=>"unlocked",
+ "timestamp"=>1640393667,
+ "wm2State"=>true}
+```
+
+
+### histories
+
+```ruby
+client.histories
+=>
+[{"recordID"=>312,
+  "type"=>11,
+  "timeStamp"=>1640393671108,
+  "cast_type"=>:driveUnlocked},
+ {"recordID"=>311,
+  "type"=>17,
+  "timeStamp"=>1640393668401,
+  "historyTag"=>"d2ViYXBp",
+  "cast_type"=>nil,
+  "name"=>"webapi"}
+]
+```
+
+You can also pass page or lg arguments.
+
+```ruby
+client.histories(page: 2, lg: 10)
+=>
+[{"recordID"=>318,
+  "type"=>11,
+  "timeStamp"=>1640394507582,
+  "cast_type"=>:driveUnlocked}]
+```
+
+### unlock
+
+```ruby
+client.unlock
+=> {:status=>200}
+```
+
+### lock
+
+```ruby
+client.lock
+=> {:status=>200}
+```
+
+### toggle
+
+```ruby
+client.toggle
+=> {:status=>200}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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 the created tag, 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/ihatov08/sesame_os2.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sesame_os2"
+
+# 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/lib/sesame_os2/client.rb

@@ -0,0 +1,95 @@
+require 'faraday'
+require 'base64'
+require 'digest/cmac'
+require 'json'
+
+module SesameOs2
+  class Client
+    API_ENDPOINT = 'https://app.candyhouse.co/api/sesame2'
+
+    HISTORY_TYPES = {
+      0 => :none,
+      1 => :bleLock,
+      2 => :bleUnLock,
+      3 => :timeChanged,
+      4 => :autoLockUpdated,
+      5 => :mechSettingUpdated,
+      6 => :autoLock,
+      7 => :manualLocked,
+      8 => :manualUnlocked,
+      9 => :manualElse,
+     10 => :driveLocked,
+     11 => :driveUnlocked,
+     12 => :driveFailed,
+     13 => :bleAdvParameterUpdated,
+    }
+
+    COMMAND = {
+      toggle: 88,
+      lock: 82,
+      unlock: 83
+    }.freeze
+
+    def initialize(api_key: ENV['SESAME_API_KEY'], name:, ssm: ENV['SESAME_SSM'])
+      @api_key = api_key
+      @name = name
+      @ssm = Ssm.new(ssm: ssm)
+    end
+
+    def status
+      res = client.get(uuid)
+      JSON.parse(res.body)
+    end
+
+    def histories(page: 0, lg: 50)
+      res = client.get("#{uuid}/history", { page: page, lg: lg })
+      parsed_body = JSON.parse(res.body)
+
+      return parsed_body if res.status != 200
+
+      parsed_body.map do |body|
+        body['cast_type'] = HISTORY_TYPES[body['type']]
+        body['name'] = Base64.decode64(body['historyTag']) if body['historyTag']
+        body
+      end
+    end
+
+    def command(command:)
+      res = client.post("#{uuid}/cmd") do |req|
+        req.body = { cmd: command, history: encoded64_name, sign: sign }.to_json
+      end
+
+      { status: res.status }
+    end
+
+    COMMAND.each do |command, value|
+      define_method(command) do
+        command(command: value)
+      end
+    end
+
+    private
+
+    attr_reader :api_key, :name, :ssm
+
+    def client
+      @client = ::Faraday.new(url: API_ENDPOINT, headers: { 'x-api-key' => api_key })
+    end
+
+    def uuid
+      ssm.uuid
+    end
+
+    def secret_key
+      ssm.secret_key
+    end
+
+    def encoded64_name
+      Base64.encode64(name)
+    end
+
+    def sign
+      Sign.create(secret_key: secret_key)
+    end
+  end
+end

data/lib/sesame_os2/sign.rb

@@ -0,0 +1,39 @@
+module SesameOs2
+  class Sign
+    def initialize(secret_key:)
+      @secret_key = secret_key
+    end
+
+    class << self
+      def create(secret_key:)
+        new(secret_key: secret_key).create
+      end
+    end
+
+    def create
+      digest.unpack1("H*")
+    end
+
+    private
+
+    attr_reader :secret_key
+
+    def message
+      [Time.now.to_i].pack("i*").unpack1("H*")[2, 8]
+    end
+
+    def key
+      [secret_key].pack("H*")
+    end
+
+    def cmac
+      Digest::CMAC.new(OpenSSL::Cipher.new("aes-128-cbc"), key).tap do |c|
+        c.update([message].pack("H*"))
+      end
+    end
+
+    def digest
+      cmac.digest
+    end
+  end
+end

data/lib/sesame_os2/ssm.rb

@@ -0,0 +1,59 @@
+require 'base64'
+
+module SesameOs2
+  class Ssm
+    def initialize(ssm:)
+      @ssm = ssm
+    end
+
+    def name
+      information['n']
+    end
+
+    def uuid
+      unpacked = unpacked_sk[83..99].pack("C*").unpack("H*").first.upcase
+
+      parts = [
+        unpacked[0..7],
+        unpacked[8..11],
+        unpacked[12..15],
+        unpacked[16..19],
+        unpacked[20..-1]
+      ]
+
+      parts.join('-')
+    end
+
+    def key_index
+      unpacked_sk[81..82].pack("C*").unpack("H*").first
+    end
+
+    def secret_key
+      unpacked_sk[1..16].pack("C*").unpack("H*").first
+    end
+
+    def publick_key
+      unpacked_sk[17..80].pack("C*").unpack("H*").first
+    end
+
+    def information
+      URI::decode_www_form(parsed_ssm.query).to_h
+    end
+
+    private
+
+    attr_reader :ssm
+
+    def parsed_ssm
+      URI.parse(ssm)
+    end
+
+    def sk
+      information['sk']
+    end
+
+    def unpacked_sk
+      Base64.decode64(sk).unpack("C*")
+    end
+  end
+end

data/lib/sesame_os2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SesameOs2
+  VERSION = "0.1.0"
+end

data/lib/sesame_os2.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "sesame_os2/version"
+require "sesame_os2/ssm"
+require "sesame_os2/client"
+require "sesame_os2/sign"
+
+module SesameOs2
+end

data/sesame_os2.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sesame_os2/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sesame_os2"
+  spec.version       = SesameOs2::VERSION
+  spec.authors       = ["ihatov08"]
+  spec.email         = ["ihatov08@gmail.com"]
+
+  spec.summary       = "Ruby wrapper for CANDIHOUSE sesame os2 Web API"
+  spec.homepage      = "https://github.com/ihatov08/sesame_os2"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ihatov08/sesame_os2"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'digest-cmac'
+  spec.add_dependency 'faraday'
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: sesame_os2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ihatov08
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest-cmac
+  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: faraday
+  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: 
+email:
+- ihatov08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sesame_os2.rb
+- lib/sesame_os2/client.rb
+- lib/sesame_os2/sign.rb
+- lib/sesame_os2/ssm.rb
+- lib/sesame_os2/version.rb
+- sesame_os2.gemspec
+homepage: https://github.com/ihatov08/sesame_os2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ihatov08/sesame_os2
+  source_code_uri: https://github.com/ihatov08/sesame_os2
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for CANDIHOUSE sesame os2 Web API
+test_files: []