purple_air_api 0.1.0 → 0.1.1

data/lib/purple_air_api/V1/sensors/get_sensor.rb

@@ -18,9 +18,10 @@ module PurpleAirApi
       end
 
       # Creates a HTTP friendly options hash depending on your inputs
-      # @!method initialize(client:, **options)
+      # @!method initialize(client:, sensor_index:, read_key: nil)
       # @param client [Faraday::Connection] Your HTTP client initialized in Client
-      # @param options [Hash] Your HTTP options for the request.
+      # @param sensor_index [Integer] The sensor_index for the sensor you want to request data from.
+      # @param read_key [String] The read_key for the sensor you want to request data from if it is a private sensor.
 
       def initialize(client:, sensor_index:, read_key: nil)
         @http_client = client
@@ -43,9 +44,9 @@ module PurpleAirApi
         json_response
       end
 
-      # Takes the raw response from PurpleAir and parses the JSON.
+      # Takes the raw response from PurpleAir and parses the JSON into a Hash.
       # @!method json_response
-      # @return [Json]
+      # @return [Hash]
       # @example json_response example
       #   response.json_response
       #   {

data/lib/purple_air_api/V1/sensors/get_sensors.rb

@@ -70,9 +70,9 @@ module PurpleAirApi
         @parsed_response ||= parse_response
       end
 
-      # Takes the raw response from PurpleAir and parses the JSON.
+      # Takes the raw response from PurpleAir and parses the JSON into a Hash.
       # @!method json_response
-      # @return [Json]
+      # @return [Hash]
       # @example json_response example
       #   response.json_response
       #   {
@@ -130,20 +130,22 @@ module PurpleAirApi
       def location_type(location_type)
         return {} if location_type.nil?
 
-        unless location_type.instance_of?(Array) && location_type.first.instance_of?(String)
-          raise OptionsError,
-                "location_type must be an array of strings specifying either ['inside'], ['outside'], or both"
-        end
-
-        location_type.map!(&:downcase)
+        location_type_error unless location_type.instance_of?(Array) && location_type.first.instance_of?(String)
 
-        location_type_parameter(location_type)
+        location_type_parameter(location_type.map(&:downcase))
       end
 
       def location_type_parameter(location_type)
         return {} if location_type.include?('outside') && location_type.include?('inside')
         return { location_type: 1 } if location_type.include?('inside')
         return { location_type: 0 } if location_type.include?('outside')
+
+        location_type_error
+      end
+
+      def location_type_error
+        raise OptionsError,
+              "location_type must be an array of strings specifying either ['inside'], ['outside'], or both"
       end
 
       def modified_since(timestamp)

data/lib/purple_air_api/version.rb

@@ -2,5 +2,5 @@
 
 module PurpleAirApi
   # The gem version
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/purple_air_api.gemspec

@@ -8,16 +8,19 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dylan Kiselbach']
   spec.email         = ['dylankiselbach@gmail.com']
 
-  spec.summary       = 'This is an library to assist in interacting with the PurpleAir API.'
-  spec.description   = 'To use this gem you will need your own read and write key from PurpleAir which can be retrieved
-                        by contacting their support team https://www2.purpleair.com/pages/contact-us.'
+  spec.summary       = 'This is a Ruby wrapper for the PurpleAir API.'
+  spec.description   = 'This gem is a API wrapper for the PurpleAir API intended to help in making requests
+                        to PurpleAir. Please refer to the documentation for details on usage and how to get
+                        started using this gem.'
   spec.homepage      = 'https://github.com/dkiselbach/purple_air_api'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/dkiselbach/purple_air_api.'
-  spec.metadata['changelog_uri'] = 'https://github.com/dkiselbach/purple_air_api.'
+  spec.metadata['source_code_uri'] = 'https://github.com/dkiselbach/purple_air_api'
+  spec.metadata['changelog_uri'] = 'https://github.com/dkiselbach/purple_air_api'
+
+  spec.extra_rdoc_files = ['README.md']
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purple_air_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dylan Kiselbach
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,13 +39,15 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 description: |-
-  To use this gem you will need your own read and write key from PurpleAir which can be retrieved
-                          by contacting their support team https://www2.purpleair.com/pages/contact-us.
+  This gem is a API wrapper for the PurpleAir API intended to help in making requests
+                          to PurpleAir. Please refer to the documentation for details on usage and how to get
+                          started using this gem.
 email:
 - dylankiselbach@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - ".gitignore"
 - ".rspec"
@@ -58,6 +60,33 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/PurpleAirApi.html
+- docs/PurpleAirApi/V1.html
+- docs/PurpleAirApi/V1/ApiError.html
+- docs/PurpleAirApi/V1/ApiKeyError.html
+- docs/PurpleAirApi/V1/BaseError.html
+- docs/PurpleAirApi/V1/Client.html
+- docs/PurpleAirApi/V1/GetSensor.html
+- docs/PurpleAirApi/V1/GetSensors.html
+- docs/PurpleAirApi/V1/MissingJsonPayloadError.html
+- docs/PurpleAirApi/V1/NotFoundError.html
+- docs/PurpleAirApi/V1/OptionsError.html
+- docs/PurpleAirApi/V1/RaiseHttpException.html
+- docs/PurpleAirApi/V1/ServerError.html
+- docs/_index.html
+- docs/class_list.html
+- docs/css/common.css
+- docs/css/full_list.css
+- docs/css/style.css
+- docs/file.README.html
+- docs/file_list.html
+- docs/frames.html
+- docs/index.html
+- docs/js/app.js
+- docs/js/full_list.js
+- docs/js/jquery.js
+- docs/method_list.html
+- docs/top-level-namespace.html
 - lib/purple_air_api.rb
 - lib/purple_air_api/V1/client.rb
 - lib/purple_air_api/V1/errors.rb
@@ -72,8 +101,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/dkiselbach/purple_air_api
-  source_code_uri: https://github.com/dkiselbach/purple_air_api.
-  changelog_uri: https://github.com/dkiselbach/purple_air_api.
+  source_code_uri: https://github.com/dkiselbach/purple_air_api
+  changelog_uri: https://github.com/dkiselbach/purple_air_api
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -92,5 +121,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: This is an library to assist in interacting with the PurpleAir API.
+summary: This is a Ruby wrapper for the PurpleAir API.
 test_files: []