maju 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 609dd3f7ad78fddfa86061824a674bce4ef6fecdb821351c2bb6941ee8db8a8b
+  data.tar.gz: 75d72a96ffaab01517bcf44ac480e032b0f0bec5abbfad95aafe7717b03556c1
+SHA512:
+  metadata.gz: 6cf342cb602f4d070b3110e53ea44bec41ae7ad7d6ee788e11044791bb25cf85b5b0bab0643936a9c662c0d05460770c6473eac98829974a5832edfc7a226e7c
+  data.tar.gz: cdd3e7a4a3881e242aea3cd2a9ec0b99627f0a0c75500dae0bc58c577a7783fe052af7b5eb76d7aa343f491386b999df51bd25c054a8840ba1ff963d2c2de27b

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in maju.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "rest-client", "~> 2.1"

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    maju (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    netrc (0.11.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  maju!
+  pry
+  rake (~> 13.0)
+  rest-client (~> 2.1)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.4.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Raphael Ivan
+
+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,69 @@
+# StringHelpers
+Get weather informations from OpenWeather
+
+## Install
+
+```sh
+gem install maju
+```
+or add to your Gemfile
+
+```sh
+gem maju
+```
+
+## Configuration
+Before usage, you need to create a account on[Open Weather Site](https://openweathermap.org/) and gerenate a API key. To create an API key, follow the steps in [this tutorial](https://openweathermap.org/guide)
+
+After get your API KEY, you need to start the client.
+
+```ruby
+ client = Maju::Client.new(api_token: 'YOUR_API_KEY_HERE')
+```
+
+
+
+## Usage
+Get today information about weather. You need to pass city name params 
+
+```ruby
+ client.current(city: 'Monte Santo de Minas')
+```
+or to pass lat and long cordinates
+
+```ruby
+ client.current(lat: '-21.2049202', long: '-47.0943532')
+```
+
+## Geocode
+
+if you need to find out lat and long of some city you can use geocode method
+```ruby
+ client.geocode(city: 'Monte Santo de Minas')
+```
+will returns: 
+
+```json
+[
+    {
+        "name": "Mococa",
+        "lat": -21.464731,
+        "lon": -47.002405,
+        "country": "BR",
+        "state": "São Paulo"
+    }
+]
+```
+
+## Forecasts
+To get forecast for the days ahead, you can use the forecast method. If you don't know lat and long informations, use the geocode method.
+
+```ruby
+ client.current(lat: '-21.2049202', long: '-47.0943532')
+```
+
+
+## License
+StringHelper is available under the MIT license.
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/maju/maju.rb

@@ -0,0 +1,45 @@
+require 'rest-client'
+require_relative 'support/helpers'
+require_relative 'support/error'
+
+module Maju
+	class Client		
+		include Maju::Helpers
+
+		attr_accessor :token, :lang, :unit
+
+		def initialize(options)
+			@token   = options[:api_token]
+			@lang = options[:lang] ? options[:lang] : 'en'
+			@unit   = check_metric(options[:unit].to_s)
+
+		  Maju::Errors.api_token_blank if !@token || @token.empty?
+		end
+
+		def current(params)
+		  Maju::Errors.city_geocode_blank if params[:city].nil? && params[:lat].nil?
+		
+			url = api_url_current(params)
+			response = RestClient.get(url, headers)
+			json(response)
+		end
+
+
+		def forecast(params)
+		  Maju::Errors.city_geocode_blank if params[:city].nil? && params[:lat].nil?
+
+			url = api_url_forecast(params)
+			response = RestClient.get(url, headers)
+			json(response)
+		end
+
+
+		def geocode(params)
+		  Maju::Errors.city_name_blank if params[:city].nil? or params[:city].to_s.empty?
+
+			url = api_url_geocode(params)
+			response = RestClient.get(url, headers)
+			json(response).count > 1 ? json(response) : json(response).first
+		end
+	end
+end

data/lib/maju/support/error.rb

@@ -0,0 +1,14 @@
+module Maju::Errors
+  def self.api_token_blank
+    raise "API-TOKEN: Need to configure api_token. Use: Maju::Client.new(api_token: <YOUR_API_TOKEN>)"
+  end
+
+
+  def self.city_geocode_blank
+    raise "Provider city or lat log params. Use: {city: 'Mococa', lat: 'xxxxx', long: 'xxxxxx'} "
+  end
+
+  def self.city_name_blank
+    raise "Provider the city name. Use: {city: 'Mococa' } "
+  end
+end

data/lib/maju/support/helpers.rb

@@ -0,0 +1,54 @@
+require 'json'
+
+module Maju::Helpers
+	def api_url_base
+		"https://api.openweathermap.org"
+	end
+
+	def api_url_current(params)
+		"#{api_url_base}/data/2.5/weather?" + parsed_params(params)
+	end
+
+	def api_url_forecast(params)
+		days_count = (params[:days_count] && params[:days_count] <= 15) ? params[:days_count] : 15
+
+		url = "#{api_url_base}/data/2.5/forecast" + parsed_params(params)
+		url +="&cnt=#{days_count}" if params && params[:days_count]
+		url
+	end
+
+
+	def api_url_geocode(params)
+		url = "#{api_url_base}/geo/1.0/direct" + parsed_params(params)
+		url
+	end
+
+	def headers
+		{}
+	end	
+
+	def parsed_params(params)
+		if params[:city]
+			"?lang=#{@lang}&units=#{@unit}&q=#{params[:city]}&appid=#{@token}"
+		else
+			"?lang=#{@lang}&units=#{@unit}&appid=#{@token}&lat=#{params[:lat]}&lon=#{params[:long]}"
+		end
+	end
+
+	def json(json)
+		JSON.parse(json)
+	end	
+
+	def check_metric(metric)
+		case metric.downcase
+		when 'celsius'
+			'metric'
+		when	'fahrenheit'
+			'imperial'
+		when 'Kelvin'
+			'standard'
+		else
+			'metric'
+		end
+	end
+end

data/lib/maju/version.rb

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

data/lib/maju.rb

@@ -0,0 +1,5 @@
+require_relative "maju/version"
+require_relative 'maju/maju'
+
+module Maju
+end

data/sig/maju.rbs

@@ -0,0 +1,4 @@
+module Maju
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: maju
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Raphael Ivan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-13 00:00:00.000000000 Z
+dependencies: []
+description: Get weather information directly from the console or easily integrate
+  your application with OpenWeather
+email:
+- eu@rpha.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/maju.rb
+- lib/maju/maju.rb
+- lib/maju/support/error.rb
+- lib/maju/support/helpers.rb
+- lib/maju/version.rb
+- sig/maju.rbs
+homepage: https://rubygems.org/gems/maju
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://rubygems.org/gems/maju
+  source_code_uri: https://github.com/raphaelivan/maju
+  changelog_uri: https://github.com/raphaelivan/maju
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Get weather informations from OpenWeather
+test_files: []