darksky_weather-api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8bd21657beb125dc98f3c51b3977657043ec25c2751808719da0d79d9a60c77
-  data.tar.gz: ca55d7395122e2f7fd7d5577bb71bb75cc5f0c3929e00e05a89a4604a7e8821b
+  metadata.gz: 4eba09792870cf4182256c99e2e1234bcf39f903efd575fc4ce685207e46c6da
+  data.tar.gz: e5f84fef340ef2d477c69616351a0bde93e57e79960f550495fb26bf90d977a5
 SHA512:
-  metadata.gz: 9774400e23f8776038041b587438d94c6f1290848daa32334bccfe5deb932f4593aa2fb4df749a6cd0f407558fb4a4f1b77ff41bbcb9449f63320d6be212a28e
-  data.tar.gz: 977ec6e9f44bf6cb797ef0267ef5b237bb81c35a6a8db281407fe00baea03fa9d92f0d06f2c0c75fdd4f2bf8c3ddd56d62266d2bdf525af7446a79193a2db684
+  metadata.gz: 97b948b1eac878fd2eb465992e21935390cd1ce494f500cd44ce5f36b4d6cd2ca3a7ed6b09456e3e35baf4e74c9110655667117e343539234051fb41db245cbf
+  data.tar.gz: 79c326c4241a7fbdfc352ab1e6ce2786cdb13d2fa778051d626638dd8fc3c6cd5d3594b38fc87feeeceb1c378e9718e38969834f1a61cbde1f8f79b63b1b6343

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.2.2 (2019-12-02)
+
+* Support optional request args.
+
 ### 0.1.2 (2019-09-20)
 
 * Changed module names and paths to make auto-inclusion work properly

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    darksky_weather-api (0.2.1)
+    darksky_weather-api (0.2.2)
       activesupport
       httparty
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.0)
+    activesupport (6.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     httparty (0.17.1)
@@ -24,7 +24,7 @@ GEM
     mime-types (3.3)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0904)
-    minitest (5.12.2)
+    minitest (5.13.0)
     multi_xml (0.6.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -43,7 +43,7 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.10)
+    zeitwerk (2.2.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -49,13 +49,16 @@ To fetch the current weather for a given location, you'll need to know the latit
 
 ```ruby
 client       = DarkskyWeather::Api::Client.new
+opts         = {units: 'auto'}
 lat, lng     = [37.8267, -122.4233]
-weather_data = client.get_weather(lat: lat, lng: lng)
+weather_data = client.get_weather(lat: lat, lng: lng, opts: opts)
 ```
 
 Note the use of kwargs in the method call. Calling the `get_weather` method will return a `WeatherData` object that defines a number of useful methods/attributes. The attributes all correspond to the snake-cased version of the JSON key present in the API response. For instance, `weather_data.currently.apparent_temperature` corresponds with the JSON at `raw_response['currently']['apparentTemperature']`.
 
-For more information about all of the data that comes back from the request, [see the documentation](https://darksky.net/dev/docs).
+The `opts` hash will be converted into a query string and may contain key/value pairs for the four optional query parameters supported by the Darksky Api: `extend`, `units`, `exclude`, and `lang`.
+
+For more information about the optional parameters and all of the data that comes back from the request, [see the documentation](https://darksky.net/dev/docs).
 
 In addition, you can retrieve the URL for your particular API request by calling `source_url` on the `WeatherData` instance.
 

data/lib/darksky_weather/api/client.rb

@@ -6,12 +6,19 @@ module DarkskyWeather
       include HTTParty
       base_uri "https://api.darksky.net/forecast/"
 
-      def get_weather(lat:, lng:, timestamp: nil)
+      def get_weather(lat:, lng:, timestamp: nil, opts: {})
         key         = DarkskyWeather::Api.configuration.api_key
 
         request_path   = "/#{key}/#{lat},#{lng}"
         request_path << ",#{timestamp}" if timestamp
 
+        allowed_opts = %w(extend exclude lang units)
+        opts.each_with_index do |o, idx|
+          next unless allowed_opts.include?(o.first.to_s)
+          sep_sym = idx == 0 ? '?' : '&'
+          request_path << "#{sep_sym}#{o.first}=#{o.last}"
+        end
+
         raw_result  = self.class.get(request_path)
         request_uri = raw_result.request.uri.to_s
 

data/lib/darksky_weather/api/version.rb

@@ -1,5 +1,5 @@
 module DarkskyWeather
   module Api
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: darksky_weather-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Lojistic Dev Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-22 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty