ambient-ruby-client 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f5774b557c895de5da75ebbc1a1aeae0d0d0c3ce1dd5414652d867ae8738663
+  data.tar.gz: 2bbfeea305c3c8e2eab7cdd7c7f04937af5a4f31389c231b48dd1f524efc55d6
+SHA512:
+  metadata.gz: '069b20da0446e1ea4df52e0c446199395dcbb9a80a6b2e2a97451a614116fe75f6fece86220f83e2d1bd3a031c96c70421518d00b147424d57845a69369b2e1d'
+  data.tar.gz: 6be6e04180d5251aa160879b617308253e0c637f1fd03b982af5e014d64acecaeb6763eac3bf078919ee799e29b1a16684571c444b80a31a97a84b12c5633ec6

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# 0.1.2
+The initial version

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 TODO: Write your name
+
+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,25 @@
+# Ambient::Ruby::Client
+
+A Ruby gem that interacts with the [Ambient Weather REST API](https://ambientweather.docs.apiary.io/#introduction).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ambient-ruby-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+TODO: Write development instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jar349/ambient-ruby-client.
+
+## 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,3 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"

data/lib/ambient/client.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+
+require_relative "client_config"
+require_relative "device"
+
+module Ambient
+  class ClientError < StandardError; end
+
+  class Client
+    ##
+    # Creates a new Ambient Client
+    #
+    # @param client_config [Ambient.ClientConfiguration] the configuration for the Ambient client.
+    def initialize(client_config)
+      @config = client_config
+    end
+
+    def devices
+      path = "devices"
+      
+      begin
+        response = _get(path, @config)
+      rescue StandardError => se
+        raise Ambient::ClientError, "Error while getting the list of devices from the Ambient API (#{se.class.name}): #{se.message}"
+      end
+
+      unless response.is_a? Net::HTTPOK
+        raise Ambient::ClientError, "The response from the Ambient API was not what was expected, got #{response.class.name} instead of Net::HTTPOK"
+      end
+
+      response_data = JSON.parse(response.body)
+      array_of_devices = []
+      response_data.each do |device_data|
+        array_of_devices << Ambient::Device.from_hash(device_data)
+      end
+
+      array_of_devices
+    end
+
+    def device_data(device_mac_address, end_date: nil, limit: 288)
+      path = "devices/macAddress"
+      params = {macAddress: device_mac_address, endDate: end_date, limit: }
+
+      begin
+        response = _get(path, @config, params: )
+      rescue StandardError => se
+        raise Ambient::ClientError, "Error while getting device data from the Ambient API #{se.class.name}: #{se.message}"
+      end
+
+      unless response.is_a? Net::HTTPOK
+        raise Ambient::ClientError, "The response from the Ambient API was not what was expected, got #{response.class.name} instead of Net::HTTPOK"
+      end
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    # :nocov:
+    def _get(path, config, params: {})
+      uri = URI("#{@config.api_url}/#{path}")
+      all_params = params.merge({applicationKey: @config.app_key, apiKey: @config.api_key})
+      uri.query = URI.encode_www_form(all_params)
+      headers = {Accept: "application/json"}
+
+      Net::HTTP.get_response(uri, headers)
+    end
+    # :nocov:
+  end
+end

data/lib/ambient/client_config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Ambient
+  class ClientConfiguration
+    attr_reader :api_key, :app_key, :api_url
+
+    ##
+    # Creates a new Ambient Client
+    #
+    # @param api_key [String] the configuration for the Ambient client.
+    def initialize(api_key:, app_key:, api_url:)
+      @api_key = api_key
+      @app_key = app_key
+      @api_url = api_url
+    end
+  end
+end
+  

data/lib/ambient/device.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Ambient
+  class DeviceInfo
+    attr_reader :name, :location
+
+    def self.from_hash(data)
+      DeviceInfo.new(data.dig("name"), data.dig("location"))
+    end
+
+    def initialize(name, location)
+      @name = name
+      @location = location
+    end
+  end
+
+  class Device
+    attr_reader :mac_address, :info, :last_data
+
+    def self.from_hash(data)
+      Device.new(data.dig("macAddress"), Ambient::DeviceInfo.from_hash(data.dig("info")), data.dig("lastData"))
+    end
+
+    ###
+    # Create a new Device instance
+    #
+    # @param mac_address [String] the mac address of the device
+    # @param info [Ambient::DeviceInfo] information about the device
+    # @param last_data [Hash] the latest measurement data from the device
+    def initialize(mac_address, info, last_data)
+      @mac_address = mac_address,
+      @info = info
+      @last_data = last_data
+    end
+  end
+end

data/lib/ambient.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "ambient/client"
+require_relative "version"

data/lib/version.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: ambient-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- John Ruiz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-09-04 00:00:00.000000000 Z
+dependencies: []
+description: Use this gem to get data from the Ambient Weather REST API
+email:
+- jruiz@johnruiz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ambient.rb
+- lib/ambient/client.rb
+- lib/ambient/client_config.rb
+- lib/ambient/device.rb
+- lib/version.rb
+homepage: https://github.com/jar349/ambient-ruby-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jar349/ambient-ruby-client
+  source_code_uri: https://github.com/jar349/ambient-ruby-client
+  changelog_uri: https://github.com/jar349/ambient-ruby-client/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Ambient Weather REST API
+test_files: []