open-weather-api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65b0e18d84c87ea5d6bc9709a9a816e8d3255f95
-  data.tar.gz: e875db9ab10e3106fdebfc71c167e5c59e9fb783
+  metadata.gz: c205d1489bacdd708f89abdb8ab9dcd5aa028b81
+  data.tar.gz: ffb9d41f9c4cf01aceef87625b88c95570b9e565
 SHA512:
-  metadata.gz: 3a4b690505ec259f619696b0bbe217fcab3acb5972c9683fb101154aa248a5a75912b5be20828aff24c2d9f33cfd6fea12cf458597793235973dbcb84ad5d4eb
-  data.tar.gz: c60e78f5eddd4aae49efe20392035c728de3731cb9d56f27d36982c08cc6caaafa9afbf1fab55fa3c3b0f1d15d48b716358a86949ca9dfa33be89edad287fa1b
+  metadata.gz: 79e8f94c2eff7064a2bbcea6958a313c6e9c652622782b0511ce4570894c1e5a236176aaeb7d5dc2dc42601f1cbcccf62681641110bc1151d803bac4e5f88983
+  data.tar.gz: 28475feb664172eee48796822d784879f822387df0c93fdda30933ea27f5516a8c81e8606ca6dfe51a4050bbc87cb3b6457a9b065eb634f793d78f8751a662cc

data/README.md

@@ -31,15 +31,28 @@ First, you need to init the API:
 ```ruby
 # config/initializers/open-weather-api.rb
 
-Rails.configuration.open_weather_api = OpenWeatherAPI::API.new api_key: ENV['OPEN_WEATHER_API_KEY'], language: 'es', units: 'metric'
+# Note that 'config' is an instance of `OpenWeatherAPI::API` (just name it as you like).
+OpenWeatherAPI.configure do |config|
+  # API key
+  config.api_key = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+
+  # Optionals
+  config.default_language = 'es'     # 'en' by default
+  config.default_country_code = 'es' # nil by default (ISO 3166-1 alfa2)
+  config.default_units = 'metric'    # 'metric' by default
+end
 ```
 
-`language`, `default_country_code` and `metrics` are optional values, with defaults `'en'`, `nil` and `'metric'`.
+Outside of the configuration file, you can access the `api` object as follows:
+
+````ruby
+Rails.configuration.open_weather_api
+````
 
 ### Other
 
 ```ruby
-open_weather_api = OpenWeatherAPI::API.new api_key: ENV['OPEN_WEATHER_API_KEY'], language: 'es', units: 'metric'
+open_weather_api = OpenWeatherAPI::API.new api_key: ENV['OPEN_WEATHER_API_KEY'], default_language: 'es', default_units: 'metric', default_country_code: 'es'
 # ...
 ```
 
@@ -47,7 +60,7 @@ open_weather_api = OpenWeatherAPI::API.new api_key: ENV['OPEN_WEATHER_API_KEY'],
 
 Finally, you can use the different resources of the API:
 
-**NOTE**: You can add manually any parameter you need for each request.
+**NOTE**: You can add manually any parameter you need for each request, and they will override the computed parameters.
 
 ### Current Weather
 
@@ -112,7 +125,7 @@ TODO.
 Retrieve icon url:
 
 ````ruby
-api.current city: 'Santa Cruz de Tenerife', country_code: 'es' do |json|
+open_weather_api.current city: 'Santa Cruz de Tenerife', country_code: 'es' do |json|
   puts "Icon url: #{api.icon_url json['weather'].first['icon']}"
 end
 ````

data/lib/open-weather-api.rb

@@ -10,4 +10,5 @@ require 'open-weather-api/resources/base'
 require 'open-weather-api/resources/current'
 require 'open-weather-api/resources/handlers/base'
 require 'open-weather-api/resources/handlers/current'
+require 'open-weather-api/config'
 require 'open-weather-api/api'

data/lib/open-weather-api/api.rb

@@ -1,15 +1,13 @@
 module OpenWeatherAPI
   class API
 
-    attr_reader :api_key, :options
-    attr_accessor :default_language, :default_country_code, :default_units
+    attr_accessor :api_key, :default_language, :default_country_code, :default_units
 
     def initialize(options = {})
-      @options = options
       @api_key = options[:api_key] || options['api_key']
-      @default_language = options[:language] || options['language'] || 'en'
+      @default_language = options[:default_language] || options['default_language'] || 'en'
       @default_country_code = options[:default_country_code] || options['default_country_code']
-      @default_units =  options[:units] || options['units'] || 'metric'
+      @default_units =  options[:default_units] || options['default_units'] || 'metric'
     end
 
     def current(**args, &block)

data/lib/open-weather-api/config.rb

@@ -0,0 +1,9 @@
+module OpenWeatherAPI
+  def self.configure(&block)
+    raise ArgumentError, 'No block was given.' unless block
+
+    api = Rails.configuration.open_weather_api = OpenWeatherAPI::API.new
+    block.call(api)
+    api
+  end
+end

data/lib/open-weather-api/version.rb

@@ -1,3 +1,3 @@
 module OpenWeatherApi
-  VERSION = "0.0.2"
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open-weather-api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Wikiti
@@ -38,6 +38,7 @@ files:
 - doc/icon.png
 - lib/open-weather-api.rb
 - lib/open-weather-api/api.rb
+- lib/open-weather-api/config.rb
 - lib/open-weather-api/resources/base.rb
 - lib/open-weather-api/resources/current.rb
 - lib/open-weather-api/resources/handlers/base.rb