owa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88d8bef6dd5b6f2fb71e2f3d9612cfa754afb477
+  data.tar.gz: 3b7bc6cf50a4fe6b95fefdfcc34cb898dfdb860e
+SHA512:
+  metadata.gz: 91c6ab8e5a44f906e35da676d2fbd96632e5ae19eb51b335f733d4d097b86ad04b917ec8ce6cd827d2d09ac2808ebf7900697b1c795070a0809520eced330702
+  data.tar.gz: 8bb18bbe9e623a7df4e2d69d4c9d8656024ae478075ca9f2f8dd84daa9c9cb7fd4f04686e04ae28cef98597c22a5a31f8a035b2700cb60fa0b3780b9a273b36d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+    - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sltoussi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in owa.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# Owa (OpenWeatherApi)
+
+This is yet another API client for the https://openweathermap.org. This implimentation aims for simplicity with small objects that are mostly closed for modification and are having one responsibility.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'owa'
+```
+
+And then execute:
+
+    $ bundle
+Or install it yourself as:
+
+    $ gem install owa
+
+You will need to initialize it after installation. If you are using this gem in a Rails application you can add the initialization in your `config/initializers/owa.rb`:
+
+``` ruby
+Owa.configure do |config|
+  config.api_url="https://api.openweathermap.org/data/2.5"
+  config.appid="your_appid_from_owm_api"
+end
+```
+
+## Usage
+
+At this moment there are only two ways to use this client(more to be implemented soon):
+
+- To get a weather by a City and Countrycode. CountryCode can be used optionally.
+
+```
+Owa::Current.by_city("berlin", "DE")
+# Or
+Owa::Current.by_city("berlin")
+```
+
+- To get the weather by geocode.
+
+```
+Owa::Current.by_geocode("130", "80")
+```
+
+Note that on the events that API response is not a desired weather report this client raises errors with some messages which can be used to handle the error events and lets users know what went wrong.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hosseintoussi/owa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "owa"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/owa.rb

@@ -0,0 +1,29 @@
+require "faraday"
+require_relative "owa/version"
+require_relative "owa/current"
+require_relative "owa/errors"
+require_relative "owa/configuration"
+require_relative "owa/requests/http_client"
+require_relative "owa/requests/parser"
+require_relative "owa/requests/weather"
+require_relative "owa/requests/options/city"
+require_relative "owa/requests/options/geocode"
+
+
+module Owa
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/owa/configuration.rb

@@ -0,0 +1,5 @@
+module Owa
+  class Configuration
+    attr_accessor :api_url, :appid
+  end
+end

data/lib/owa/current.rb

@@ -0,0 +1,17 @@
+module Owa
+  class Current
+    def self.by_city(city, country_code=nil)
+      get_weather_with(Requests::Options::City.new(city, country_code))
+    end
+
+    def self.by_geocode(lon, lat)
+      get_weather_with(Requests::Options::Geocode.new(lon, lat))
+    end
+
+    private
+
+    def self.get_weather_with(options)
+      Requests::Weather.new(options).call
+    end
+  end
+end

data/lib/owa/errors.rb

@@ -0,0 +1,20 @@
+module Owa
+  class OwaErrors < StandardError; end
+  class BadRequest < OwaErrors
+    def message
+      "That was a bad request"
+    end
+  end
+
+  class Unauthorized < OwaErrors
+    def message
+      "Looks like you are not authorized"
+    end
+  end
+
+  class NotFound < OwaErrors
+    def message
+      "I couldn't find that"
+    end
+  end
+end

data/lib/owa/requests/http_client.rb

@@ -0,0 +1,21 @@
+module Owa
+  module Requests
+    class HttpClient
+			attr_reader :conn
+
+      def initialize(conn: nil)
+        @conn = conn || Faraday.new(url: Owa::configuration.api_url)
+      end
+
+      def get(endpoint, params = {})
+        conn.get(endpoint, default_params.merge(params))
+      end
+
+      private
+
+      def default_params
+				{ appid: Owa::configuration.appid }
+      end
+    end
+  end
+end

data/lib/owa/requests/options/city.rb

@@ -0,0 +1,22 @@
+module Owa
+  module Requests
+    module Options
+      class City
+        def initialize(city, country_code=nil)
+          @city = city
+          @country_code = country_code
+        end
+
+        def call
+          { q: query }
+        end
+
+        private
+
+        def query
+          [@city, @country_code].compact.join(",")
+        end
+      end
+    end
+  end
+end

data/lib/owa/requests/options/geocode.rb

@@ -0,0 +1,17 @@
+module Owa
+  module Requests
+    module Options
+      class Geocode
+        def initialize(lon, lat)
+          @lon = lon
+          @lat = lat
+        end
+
+        def call
+          { lon: @lon, lat: @lat }
+        end
+      end
+    end
+  end
+end
+

data/lib/owa/requests/parser.rb

@@ -0,0 +1,19 @@
+require "json"
+module Owa
+  module Requests
+    class Parser
+      def call(response)
+        case response.status
+        when 400
+          raise BadRequest.new
+        when 401
+          raise Unauthorized.new
+        when 404
+          raise NotFound.new
+        else
+          JSON.parse(response.body, object_class: OpenStruct)
+        end
+      end
+    end
+  end
+end

data/lib/owa/requests/weather.rb

@@ -0,0 +1,16 @@
+module Owa
+  module Requests
+    class Weather
+      def initialize(options, parser: Parser.new, http_client: HttpClient.new)
+        @parser = parser
+        @http_client = http_client
+        @options = options.call
+      end
+
+      def call
+        response = @http_client.get("weather/", @options)
+        @parser.call(response)
+      end
+    end
+  end
+end

data/lib/owa/version.rb

@@ -0,0 +1,3 @@
+module Owa
+  VERSION = "0.1.0"
+end

data/owa.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "owa/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "owa"
+  spec.version       = Owa::VERSION
+  spec.authors       = ["hosseintoussi"]
+  spec.email         = ["sltoussi@gmail.com"]
+
+  spec.summary       = %q{OWM API client}
+  spec.description   = %q{This gem is a simple client for OWM}
+  spec.homepage      = ""
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "pry"
+
+
+  spec.add_runtime_dependency "faraday"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: owa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hosseintoussi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a simple client for OWM
+email:
+- sltoussi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/owa.rb
+- lib/owa/configuration.rb
+- lib/owa/current.rb
+- lib/owa/errors.rb
+- lib/owa/requests/http_client.rb
+- lib/owa/requests/options/city.rb
+- lib/owa/requests/options/geocode.rb
+- lib/owa/requests/parser.rb
+- lib/owa/requests/weather.rb
+- lib/owa/version.rb
+- owa.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: OWM API client
+test_files: []