devicedb_comms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae8dde10e410d3e9f6fde02046869a42ecf33c89
+  data.tar.gz: 94e0e1c23a353f949756c627c5a232f6ca7081c6
+SHA512:
+  metadata.gz: 51c3fc592c37081e0b7d65ad40417dff195c2f2b170f4ebfd7f625367c292f10bb05290b0e3f2fb6ab8b602bcdfa81ba53eef0ae179768857c615dd97b6a3462
+  data.tar.gz: 8995c8b8387cc8fe60981bbfd7ad3fcf7242aba9ab283f399937711440faa000b7e78726dcbb850188adf3ba1df95143554329651cdbfbdb0d6d5d478eaebb14

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/lib/devicedb_comms.rb

@@ -0,0 +1,26 @@
+require 'virtus'
+
+require 'devicedb_comms/queue'
+require 'devicedb_comms/device'
+require 'devicedb_comms/hive'
+require 'devicedb_comms/configuration'
+
+module DeviceDBComms
+  class << self
+    # TODO Add this accessor when the configuration method is removed
+    #attr_accessor :configuration
+
+    def configure
+      # TODO Possibly change to this when configuration method removed
+      #self.configuration = Configuration.new
+      @configuration = Configuration.new
+      yield(configuration)
+    end
+
+    # For backward compatibility
+    # TODO Remove this as the configure method must be called
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+end

data/lib/devicedb_comms/configuration.rb

@@ -0,0 +1,11 @@
+module DeviceDBComms
+  class Configuration
+    include Virtus.model
+
+    attribute :url, String
+    attribute :pem_file, String
+    # Backward compatibility with version <= 0.0.14
+    # TODO Change default to VERIFY_PEER
+    attribute :ssl_verify_mode, Integer, default: OpenSSL::SSL::VERIFY_NONE
+  end
+end

data/lib/devicedb_comms/device.rb

@@ -0,0 +1,71 @@
+require 'devicedb_comms/shared'
+
+module DeviceDBComms
+  class Device < DeviceDBComms::Shared
+
+    # Backward compatibility with version <= 0.0.14
+    # TODO Remove arguments
+    def initialize(url = nil, pem_path = nil)
+      @applications = {}
+      super(url, pem_path)
+    end
+
+    def find(device_id)
+      get("/devices/#{device_id}")
+    end
+
+    def register(device_params)
+      post("/devices/register", device_params)
+    end
+
+    def edit(device_id, device_params)
+      put("/devices/#{device_id}", device: device_params)
+    end
+
+    def poll(device_id, status=nil)
+      params = {}
+      if @applications[device_id]
+        params['application'] = @applications[device_id]
+      end
+      post("/devices/#{device_id}/poll" + ( "/#{status}" unless status.nil? ).to_s, params)
+    end
+
+    def set_application(device_id, name=nil)
+      @applications[device_id] = name
+      poll(device_id)
+    end
+
+    def clear_application(device_id)
+      set_application(device_id, nil)
+    end
+
+    def get_application(device_id)
+      get("/devices/#{device_id}/application")['application']
+    end
+
+    def hive_connect(device_id, hive_id)
+      post("/hives/#{hive_id}/devices/#{device_id}/connect")
+    end
+
+    def hive_disconnect(device_id)
+      put("/hives/devices/#{device_id}/disconnect")
+    end
+
+    def action(device_id, type, body, tries = 1)
+      rtn = { 'error' => 'No tries' }
+      n = 0
+      while n < tries && rtn.has_key?('error')
+        rtn = post("/devices/#{device_id}/new_action", { action_type: type, action_body: body })
+        n += 1
+      end
+      rtn
+    end
+
+    def find_disconnected_by_type(type)
+      {
+        'devices' => []
+      }.merge(post("/devices/search", { device_type: type, hive_id: -1, status: 'idle' }))
+    end
+
+  end
+end

data/lib/devicedb_comms/hive.rb

@@ -0,0 +1,19 @@
+require 'devicedb_comms/shared'
+
+module DeviceDBComms
+  class Hive < DeviceDBComms::Shared
+
+    def find(hive_id)
+      get("/hives/#{hive_id}")
+    end
+
+    def register(hive_name, mac_address, ip_address)
+      post("/hives/register", { hive: { hostname: hive_name, mac: mac_address, ip_address: ip_address }})
+    end
+
+    def poll(hive_id)
+      post("/hives/#{hive_id}/poll")
+    end
+
+  end
+end

data/lib/devicedb_comms/queue.rb

@@ -0,0 +1,18 @@
+require 'devicedb_comms/shared'
+
+module DeviceDBComms
+  class Queue < DeviceDBComms::Shared
+
+    def find_by_name(name)
+      get("/queues/by_name/#{name.gsub(/\./, '%2E' )}")
+    end
+
+    def find(id)
+      get("/queues/#{id}")
+    end
+
+    def register(queue_params)
+      post("/queues", queue_params)
+    end
+  end
+end

data/lib/devicedb_comms/shared.rb

@@ -0,0 +1,76 @@
+require 'active_support/core_ext/object/to_query'
+require 'json'
+require 'net/http'
+
+module DeviceDBComms
+  class Shared
+
+    # Backward compatibility with version <= 0.0.14
+    # TODO Remove arguments
+    def initialize(url = nil, pem_path = nil)
+      url ||= DeviceDBComms.configuration.url
+      pem_path ||= DeviceDBComms.configuration.pem_file
+
+      if url
+        uri = URI.parse(url)
+
+        @http = Net::HTTP.new(uri.host, uri.port)
+
+        if pem_path
+          pem = File.read(pem_path)
+          @http.use_ssl = true if uri.scheme == 'https'
+          @http.cert = OpenSSL::X509::Certificate.new(pem)
+          @http.key = OpenSSL::PKey::RSA.new(pem)
+          @http.verify_mode = DeviceDBComms.configuration.ssl_verify_mode
+        end
+      else
+        @http = nil
+      end
+    end
+
+    def get(call)
+      if @http
+        begin
+          parse_response @http.request_get(call + '.json')
+        rescue StandardError => e
+          { 'error' => "GET failed: #{e.message}" }
+        end
+      else
+        { 'error' => "No DeviceDB connection" }
+      end
+    end
+
+    def post(call, params={})
+      if @http
+        begin
+          parse_response @http.request_post(call + '.json', to_query(params))
+        rescue StandardError => e
+          { 'error' => "POST failed: #{e.message}" }
+        end
+      else
+        { 'error' => "No DeviceDB connection" }
+      end
+    end
+
+    def put(call, params={})
+      if @http
+        begin
+          parse_response @http.request_put(call + '.json', to_query(params))
+        rescue StandardError => e
+          { 'error' => "PUT failed: #{e.message}" }
+        end
+      else
+        { 'error' => "No DeviceDB connection" }
+      end
+    end
+
+    def parse_response(response)
+      JSON.parse(response.body)
+    end
+
+    def to_query(params_hash)
+      params_hash.to_query
+    end
+
+  end
+end

data/lib/devicedb_comms/version.rb

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

data/lib/tasks/devicedb_comms_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :devicedb_comms do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: devicedb_comms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Haig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Communication helper gem for talking to Device Database
+email:
+- joe.haig@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/devicedb_comms.rb
+- lib/devicedb_comms/configuration.rb
+- lib/devicedb_comms/device.rb
+- lib/devicedb_comms/hive.rb
+- lib/devicedb_comms/queue.rb
+- lib/devicedb_comms/shared.rb
+- lib/devicedb_comms/version.rb
+- lib/tasks/devicedb_comms_tasks.rake
+homepage: https://github.com/bbc/devicedb_comms
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: DeviceDB Comms Gem
+test_files: []