cassia-ruby 1.0.0

data/cassia-ruby.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cassia/ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cassia-ruby"
+  spec.version       = Cassia::Ruby::VERSION
+  spec.authors       = ["adelinewang679"]
+  spec.email         = ["adelinewang679@gmail.com"]
+
+  spec.summary       = "a ruby api client for the cassia router api"
+  spec.description   = "a ruby api client for the cassia router api"
+  spec.homepage      = "https://github.com/iteratelabs/cassia-ruby.git"
+  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_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "virtus"
+  spec.add_dependency "ld-eventsource"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "vcr"
+end

data/lib/cassia/access_controller.rb

@@ -0,0 +1,111 @@
+module Cassia
+  class AccessController
+    include Virtus.model
+
+    attribute :access_token, String
+    attribute :error, String
+    attribute :error_description, String
+    attribute :autoselect_switch, Integer, default: 0
+    attribute :connected_devices, Array[Cassia::Device], default: []
+    attribute :routers, Array[Cassia::Router], default: []
+    attribute :sse
+
+    def get_token
+      Cassia::Requests::GetToken.new(self).perform
+    end
+
+    def get_all_routers_status
+      Cassia::Requests::GetAllRoutersStatus.new(self).perform
+    end
+
+    def switch_autoselect(flag: )
+      Cassia::Requests::SwitchAutoselect.new(self, flag: flag).perform
+    end
+
+    def open_scan(aps: , chip: nil, active: nil, filter_name: nil, filter_mac: nil, filter_uuid: nil)
+      Cassia::Requests::OpenScan.new(self, aps: aps, chip: chip, active: active, filter_name: filter_name, filter_mac: filter_mac, filter_uuid: filter_uuid).perform
+    end
+
+    def close_scan(aps: )
+      Cassia::Requests::CloseScan.new(self, aps: aps).perform
+    end
+
+    def connect_device(aps: '*', device_mac: )
+      Cassia::Requests::ConnectDevice.new(self, aps: aps, device_mac: device_mac).perform
+    end
+
+    def disconnect_device(device_mac: )
+      Cassia::Requests::DisconnectDevice.new(self, device_mac: device_mac).perform
+    end
+
+    def open_notify(aps: )
+      Cassia::Requests::OpenNotify.new(self, aps: aps).perform
+    end
+
+    def close_notify(aps: )
+      Cassia::Requests::CloseNotify.new(self, aps: aps).perform
+    end
+
+    def open_connection_state(aps: )
+      Cassia::Requests::OpenConnectionState.new(self, aps: aps).perform
+    end
+
+    def close_connection_state(aps: )
+      Cassia::Requests::CloseConnectionState.new(self, aps: aps).perform
+    end
+
+    def open_ap_state
+      Cassia::Requests::OpenApState.new(self).perform
+    end
+
+    def close_ap_state
+      Cassia::Requests::CloseApState.new(self).perform
+    end
+
+    def combined_sse
+      combined_sse = Cassia::Requests::CombinedSse.new(self)
+
+      self.sse = SSE::Client.new("#{ac_url}#{combined_sse.path}", headers: combined_sse.headers) do |client|
+        yield(client)
+      end
+    end
+
+    def discover_all_services(router: , device_mac: )
+      Cassia::Requests::DiscoverAllServices.new(self, router: router, device_mac: device_mac).perform
+    end
+
+    def discover_all_char(router: , device_mac: )
+      Cassia::Requests::DiscoverAllChar.new(self, router: router, device_mac: device_mac).perform
+    end
+
+    def discover_char_of_service(router: , device_mac: , service_uuid: )
+      Cassia::Requests::DiscoverCharOfService.new(self, router: router, device_mac: device_mac, service_uuid: service_uuid).perform
+    end
+
+    def discover_descriptor_of_char(router: , device_mac: , char_uuid: )
+      Cassia::Requests::DiscoverDescriptorOfChar.new(self, router: router, device_mac: device_mac, char_uuid: char_uuid).perform
+    end
+
+    def discover_all_services_and_chars(router: , device_mac: )
+      Cassia::Requests::DiscoverAllServicesAndChars.new(self, router: router, device_mac: device_mac).perform
+    end
+    
+    def write_char_by_handle(router: , device_mac:, handle: , value: )
+      Cassia::Requests::WriteCharByHandle.new(self, router: router, device_mac: device_mac, handle: handle, value: value).perform
+    end
+
+    def open_char_notification(router: , device_mac: , handle: )
+      Cassia::Requests::WriteCharByHandle.new(self, router: router, device_mac: device_mac, handle: handle, value: "0100").perform
+    end
+    
+    def close_char_notification(router: , device_mac: , handle: )
+      Cassia::Requests::WriteCharByHandle.new(self, router: router, device_mac: device_mac, handle: handle, value: "0000").perform
+    end
+
+    private
+
+    def ac_url
+      Cassia.configuration.ac_url
+    end
+  end
+end

data/lib/cassia/api.rb

@@ -0,0 +1,39 @@
+module Cassia
+  class Api
+    def post(request)
+      connection.post do |req|
+        req.url request.path
+        req.headers = request.headers
+        req.body = request.body
+      end
+    end
+
+    def get(request)
+      connection.get do |req|
+        req.url request.path
+        req.headers = request.headers
+      end 
+    end
+
+    def delete(request)
+      connection.delete do |req|
+        req.url request.path
+        req.headers = request.headers
+      end
+    end
+    
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: ac_url) do |faraday|
+        faraday.response :logger, Cassia.logger, bodies: true
+        faraday.response :json, :content_type => /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def ac_url
+      Cassia.configuration.ac_url
+    end
+  end
+end

data/lib/cassia/characteristic.rb

@@ -0,0 +1,14 @@
+module Cassia
+  class Characteristic
+    include Virtus.model
+    attribute :uuid, String
+    attribute :properties, Integer
+    attribute :handle, Integer
+    attribute :descriptors, Array
+    attribute :notification_on, Boolean
+
+    def ==(other)
+      return self.uuid == other.uuid && self.properties == other.properties && self.handle == other.handle && self.descriptors == other.descriptors
+    end
+  end
+end

data/lib/cassia/configuration.rb

@@ -0,0 +1,9 @@
+module Cassia
+  class Configuration
+    attr_accessor :client_id, :secret, :ac_url
+ 
+    def ac_url
+    	@ac_url ||= "http://demo.cassia.pro"
+    end
+  end
+end

data/lib/cassia/default_logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Cassia
+  class DefaultLogger
+    def self.build
+      Logger.new(STDOUT).tap do |logger|
+        logger.level = Logger::INFO
+      end
+    end
+  end
+end

data/lib/cassia/device.rb

@@ -0,0 +1,14 @@
+module Cassia
+  class Device
+    include Virtus.model
+    attribute :mac, String
+    attribute :type, String
+    attribute :bdaddrs
+    attribute :chipId, Integer
+    attribute :handle, String
+    attribute :name, String
+    attribute :connectionState, String
+    attribute :services, Array[Cassia::Service]
+    attribute :characteristics, Array[Cassia::Characteristic]
+  end
+end

data/lib/cassia/requests/close_ap_state.rb

@@ -0,0 +1,31 @@
+module Cassia
+  module Requests
+    class CloseApState
+      def initialize(access_controller)
+        @access_controller = access_controller
+      end
+
+      def path
+        '/api/aps/ap-state/close'
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::CloseApState.new(@access_controller).handle(Cassia.api.get(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/close_connection_state.rb

@@ -0,0 +1,38 @@
+module Cassia
+  module Requests
+    class CloseConnectionState
+      def initialize(access_controller, aps: )
+        @access_controller = access_controller
+        @aps = aps
+      end
+
+      def path
+        '/api/aps/connection-state/close'
+      end
+
+      def body
+        {
+          'aps' => @aps
+        }.to_json
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::CloseConnectionState.new(@access_controller, aps: @aps).handle(Cassia.api.post(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/close_notify.rb

@@ -0,0 +1,38 @@
+module Cassia
+  module Requests
+    class CloseNotify
+      def initialize(access_controller, aps: )
+        @access_controller = access_controller
+        @aps = aps
+      end
+
+      def path
+        '/api/aps/notify/close'
+      end
+
+      def body
+        {
+          'aps' => @aps
+        }.to_json
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::CloseNotify.new(@access_controller, aps: @aps).handle(Cassia.api.post(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/close_scan.rb

@@ -0,0 +1,38 @@
+module Cassia
+  module Requests
+    class CloseScan
+      def initialize(access_controller, aps: )
+        @access_controller = access_controller
+        @aps = aps
+      end
+
+      def path
+        '/api/aps/scan/close'
+      end
+
+      def body
+        {
+          'aps' => @aps
+        }.to_json
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::CloseScan.new(@access_controller, aps: @aps).handle(Cassia.api.post(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/combined_sse.rb

@@ -0,0 +1,27 @@
+module Cassia
+  module Requests
+    class CombinedSse
+      def initialize(access_controller)
+        @access_controller = access_controller
+      end
+
+      def path
+        "/api/aps/events"
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/connect_device.rb

@@ -0,0 +1,38 @@
+module Cassia
+  module Requests
+    class ConnectDevice
+      def initialize(access_controller, aps: '*', device_mac: nil)
+        @access_controller = access_controller
+        @aps = aps
+        @device_mac = device_mac
+      end
+
+      def path
+        '/api/aps/connections/connect'
+      end
+
+      def body
+        { 'aps' => @aps,
+          'devices' => [@device_mac] }.to_json
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::ConnectDevice.new(@access_controller).handle(Cassia.api.post(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/connect_local.rb

@@ -0,0 +1,44 @@
+module Cassia
+  module Requests
+    class ConnectLocal
+      def initialize(access_controller, router: , device_mac: nil, type: 'random', timeout: '5000', auto: '0', discovergatt: '1')
+        @access_controller = access_controller
+        @router = router
+        @device_mac = device_mac
+        @type = type
+        @timeout = timeout
+        @auto = auto
+        @discovergatt = discovergatt
+      end
+
+      def path
+        "/api/gap/nodes/#{@device_mac}/connection?mac=#{@router.mac}"
+      end
+
+      def body
+        { 'type' => @type,
+          'timeout' => @timeout,
+          'auto' => @auto,
+          'discovergatt' => @discovergatt }.to_json
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::ConnectLocal.new(@access_controller, router: @router, device_mac: @device_mac).handle(Cassia.api.post(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/disconnect_device.rb

@@ -0,0 +1,36 @@
+module Cassia
+  module Requests
+    class DisconnectDevice
+      def initialize(access_controller, device_mac: nil)
+        @access_controller = access_controller
+        @device_mac = device_mac
+      end
+
+      def path
+        '/api/aps/connections/disconnect'
+      end
+
+      def body
+        { 'devices' => [@device_mac] }.to_json
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::DisconnectDevice.new(@access_controller).handle(Cassia.api.post(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/disconnect_local.rb

@@ -0,0 +1,33 @@
+module Cassia
+  module Requests
+    class DisconnectLocal
+      def initialize(access_controller, router: , device_mac: )
+        @access_controller = access_controller
+        @router = router
+        @device_mac = device_mac
+      end
+
+      def path
+        "/api/gap/nodes/#{@device_mac}/connection?mac=#{@router.mac}"
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::DisconnectLocal.new(@access_controller, router: @router, device_mac: @device_mac).handle(Cassia.api.delete(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/discover_all_char.rb

@@ -0,0 +1,33 @@
+module Cassia
+  module Requests
+    class DiscoverAllChar
+      def initialize(access_controller, router: , device_mac: )
+        @access_controller = access_controller
+        @router = router
+        @device_mac = device_mac
+      end
+
+      def path
+        "/api/gatt/nodes/#{@device_mac}/characteristics?mac=#{@router.mac}"
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::DiscoverAllChar.new(@access_controller, router: @router, device_mac: @device_mac).handle(Cassia.api.get(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/discover_all_services.rb

@@ -0,0 +1,33 @@
+module Cassia
+  module Requests
+    class DiscoverAllServices
+      def initialize(access_controller, router: , device_mac: )
+        @access_controller = access_controller
+        @router = router
+        @device_mac = device_mac
+      end
+
+      def path
+        "/api/gatt/nodes/#{@device_mac}/services?mac=#{@router.mac}"
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::DiscoverAllServices.new(@access_controller, router: @router, device_mac: @device_mac).handle(Cassia.api.get(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end

data/lib/cassia/requests/discover_all_services_and_chars.rb

@@ -0,0 +1,33 @@
+module Cassia
+  module Requests
+    class DiscoverAllServicesAndChars
+      def initialize(access_controller, router: , device_mac: )
+        @access_controller = access_controller
+        @router = router
+        @device_mac = device_mac
+      end
+
+      def path
+        "/api/gatt/nodes/#{@device_mac}/services/characteristics/descriptors?mac=#{@router.mac}"
+      end
+
+      def headers
+        {
+          'Authorization' => "Bearer #{access_token}",
+          'Content-Type' => "application/json"
+        }
+      end
+
+      def perform
+        Cassia::ResponseHandlers::DiscoverAllServicesAndChars.new(@access_controller, router: @router, device_mac: @device_mac).handle(Cassia.api.get(self))
+      end
+
+      private
+
+      def access_token
+        @access_controller.get_token if @access_controller.access_token.nil?
+        @access_controller.access_token
+      end
+    end
+  end
+end