emergency_number 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 65a17bdc8be7f94d0b8acf4c33227cd54ec415b8
+  data.tar.gz: 87296a6d0b4e62048ca886e323d150ad8de1193d
+SHA512:
+  metadata.gz: 33341051b2c0ac638a9821ff1721c79b42bd7c182095f712f0b14ff5b2affb46c64973cdab3fbbc30148be89ff08aa49e3bb7b3fde20f524fc6594a45fde1425
+  data.tar.gz: 489d7aff7f7bfddec6ec25350c8d413fc2e689cc46cda67e051b3187afe959628de1c1640aaad64006b91e1c409a67005f872667f08485be73f2483dc72c048a

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+# gemspec
+
+gem 'httparty'
+gem 'json'
+
+group :test, :development do
+  gem 'bundler'
+  gem 'rspec'
+  gem 'rake'
+  gem 'webmock'
+  gem 'coveralls', require: false
+end

data/MIT-LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Shayon Mukherjee. https://shayon.me
+
+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,133 @@
+[![Build Status](https://travis-ci.org/shayonj/emergency_number.svg?branch=master)](https://travis-ci.org/shayonj/emergency_number)
+[![Coverage Status](https://coveralls.io/repos/github/shayonj/emergency_number/badge.svg?branch=master)](https://coveralls.io/github/shayonj/emergency_number?branch=master)
+
+# EmergencyNumber
+```EmergencyNumber``` is a ruby gem for the [Emergency Number API](http://emergencynumberapi.com/) application.
+
+ * Returns handy object to for any emergency numbers for any country in the world.
+ * Takes in one argument - ```country code```. Country can be an ISO3361-1_alpha-2 or ISO3361-1_numeric code.
+ * Authentication is not required. Rate limit is the same as it is mentioned in  [Emergency Number API docs](http://emergencynumberapi.com/docs#rate-limiting).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'emergency_number'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install emergency_number
+```
+
+## Usage
+```ruby
+require "emergency_number"
+```
+### Examples
+```ruby
+$ EmergencyNumber.get_country(:us) # or EmergencyNumber.get_country(840)
+$ EmergencyNumber.get_country(:in) # or EmergencyNumber.get_country(356)
+$ EmergencyNumber.get_country(:fr) # or EmergencyNumber.get_country(250)
+$ EmergencyNumber.get_country(:au) # or EmergencyNumber.get_country(36)
+```
+```ruby
+$ @result = EmergencyNumber.get_country(:us)
+{
+    :disclaimer => "The data from this API is provided without any claims of accuracy, you should use this data as guidance, and do your own due dilligence.",
+         :error => "",
+          :data => {
+           :country => {
+                  :name => "United States of America",
+               :ISOCode => "US",
+            :ISONumeric => "840"
+        },
+         :ambulance => {
+              :all => [""],
+              :gsm => nil,
+            :fixed => nil
+        },
+              :fire => {
+              :all => [""],
+              :gsm => nil,
+            :fixed => nil
+        },
+            :police => {
+              :all => [""],
+              :gsm => nil,
+            :fixed => nil
+        },
+          :dispatch => {
+              :all => ["911"],
+              :gsm => nil,
+            :fixed => nil
+        },
+        :member_112 => false,
+         :localOnly => false,
+            :nodata => false
+    }
+}
+```
+
+### Retrieving Data
+
+```ruby
+$ @result.data
+{
+       :country => {
+              :name => "United States of America",
+           :ISOCode => "US",
+        :ISONumeric => "840"
+    },
+     :ambulance => {
+          :all => [""],
+          :gsm => nil,
+        :fixed => nil
+    },
+          :fire => {
+          :all => [""],
+          :gsm => nil,
+        :fixed => nil
+    },
+        :police => {
+          :all => [""],
+          :gsm => nil,
+        :fixed => nil
+    },
+      :dispatch => {
+          :all => ["911"],
+          :gsm => nil,
+        :fixed => nil
+    },
+    :member_112 => false,
+     :localOnly => false,
+        :nodata => false
+}
+```
+
+### Retrieving country name
+```ruby
+$ @result.data.country.name
+=> "United States of America"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. 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/shayonj/emergency_number. 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.
+
+## License
+
+[MIT License](https://github.com/shayonj/emergency_number/blob/master/MIT-LICENSE)

data/lib/emergency_number.rb

@@ -0,0 +1,25 @@
+require_relative 'emergency_number/version.rb'
+require_relative 'normalize'
+require 'httparty'
+
+# Helps fetch JSON data from API call and returns easy to work with object.
+module EmergencyNumber
+  module_function
+
+  include HTTParty
+  # Sets the base_uri for making GET calls to Emergency Number API.
+  base_uri 'http://emergencynumberapi.com/api/country'
+
+  # Fetches list of Emergency Numbers from the Emergency Number API service.
+  #
+  # @param code [Symbol] the language code.
+  # @return [Hash] returned as Hash object in normalized dot notation form.
+  #
+  # @example Get list of number for Australia
+  #   EmergencyNumber.get_country(:au)
+  def get_country(code = :us)
+    response = get("/#{code}/")
+    body = JSON.parse(response.body, symbolize_names: true)
+    body.extend(Normalize)
+  end
+end

data/lib/emergency_number/version.rb

@@ -0,0 +1,4 @@
+module EmergencyNumber
+  # Final versioning for the gem.
+  VERSION = '0.3.1'.freeze
+end

data/lib/normalize.rb

@@ -0,0 +1,16 @@
+# Namespace and Wrapper that fetch JSON objects from Emergency Number API
+# @since 0.1.0
+
+module Normalize
+  # Return values from hash object by looking up keys from {EmergencyNumber.get_country}.
+  # Called when using dot notation on a hash object.
+  #
+  # @overload method_missing(sym, value)
+  #   @param [Symbol] sym key in the hash object.
+  #   @param [Object] * multiple number of args.
+  # @return [Object] value the respective hash key points to.
+  def method_missing(sym, *)
+    r = fetch(sym) { fetch(sym.to_s) { super } }
+    r.is_a?(Hash) ? r.extend(Normalize) : r
+  end
+end

data/spec/emergency_number_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe EmergencyNumber do
+  before :each do
+    @us = EmergencyNumber.get_country(:us)
+    @aq = EmergencyNumber.get_country(:aq)
+    @invalid = EmergencyNumber.get_country(:foobar)
+  end
+  it 'takes nil just fine' do
+    expect { EmergencyNumber.get_country }.to_not raise_error
+  end
+
+  context 'tests for valid country codes' do
+    it 'has a version number' do
+      expect(EmergencyNumber::VERSION).not_to be nil
+    end
+
+    it 'returns valid json set for valid ISO3361-1_alpha-2 or ISO3361-1_numeric code' do
+      expect(EmergencyNumber).to respond_to :get_country
+      expect(@us).not_to be_empty
+      expect(@us.data).not_to be_empty
+    end
+
+    it 'returns valid json data set for US code' do
+      expect(@us.data.country.name).to eq('United States of America')
+      expect(@us.error).to eq('')
+      expect(@us.data.dispatch.all).to eq(['911'])
+      expect(@us.data.dispatch.gsm).to eq(nil)
+      expect(@us.data.dispatch.fixed).to eq(nil)
+      expect(@us.data.nodata).to eq(false)
+    end
+
+    it 'returns non-empty and valid json set for country case like AQ.' do
+      expect(EmergencyNumber).to respond_to :get_country
+      expect(@aq).not_to be_empty
+    end
+
+    it 'returns valid json data set with valid values for AQ code' do
+      expect(@aq.data.country.name).to eq('Antarctica')
+      expect(@aq.error).to eq('No Data for this Territory')
+      expect(@aq.data.dispatch.all).to eq([''])
+      expect(@aq.data.dispatch.gsm).to eq(nil)
+      expect(@aq.data.dispatch.fixed).to eq(nil)
+      expect(@aq.data.nodata).to eq(true)
+    end
+  end
+
+  context 'tests for invalid country code' do
+    it 'returns valid json set' do
+      expect(EmergencyNumber).to respond_to :get_country
+      expect(@invalid).not_to be_empty
+      expect(@invalid.error).to eq('No Country Found')
+      expect(@invalid.data).to be_nil
+    end
+  end
+end

data/spec/fixtures/aq_response.json

@@ -0,0 +1,42 @@
+{
+  "disclaimer":"The data from this API is provided without any claims of accuracy, you should use this data as guidance, and do your own due dilligence.",
+  "error":"No Data for this Territory",
+  "data":{
+    "country":{
+      "name":"Antarctica",
+      "ISOCode":"AQ",
+      "ISONumeric":"10"
+    },
+    "ambulance":{
+      "all":[
+        ""
+      ],
+      "gsm":null,
+      "fixed":null
+    },
+    "fire":{
+      "all":[
+        ""
+      ],
+      "gsm":null,
+      "fixed":null
+    },
+    "police":{
+      "all":[
+        ""
+      ],
+      "gsm":null,
+      "fixed":null
+    },
+    "dispatch":{
+      "all":[
+        ""
+      ],
+      "gsm":null,
+      "fixed":null
+    },
+    "member_112":false,
+    "localOnly":false,
+    "nodata":true
+  }
+}

data/spec/fixtures/invalid_response.json

@@ -0,0 +1,5 @@
+{
+  "disclaimer":"The data from this API is provided without any claims of accuracy, you should use this data as guidance, and do your own due dilligence.",
+  "error":"No Country Found",
+  "data":null
+}

data/spec/fixtures/us_response.json

@@ -0,0 +1,42 @@
+{
+   "disclaimer":"The data from this API is provided without any claims of accuracy, you should use this data as guidance, and do your own due dilligence.",
+   "error":"",
+   "data":{
+      "country":{
+         "name":"United States of America",
+         "ISOCode":"US",
+         "ISONumeric":"840"
+      },
+      "ambulance":{
+         "all":[
+            ""
+         ],
+         "gsm":null,
+         "fixed":null
+      },
+      "fire":{
+         "all":[
+            ""
+         ],
+         "gsm":null,
+         "fixed":null
+      },
+      "police":{
+         "all":[
+            ""
+         ],
+         "gsm":null,
+         "fixed":null
+      },
+      "dispatch":{
+         "all":[
+            "911"
+         ],
+         "gsm":null,
+         "fixed":null
+      },
+      "member_112":false,
+      "localOnly":false,
+      "nodata":false
+   }
+}

data/spec/normalize_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Normalize do
+  context 'normalizes hashes' do
+    before :each do
+      @hsh_normal = { a: 1, b: 2, c: 3 }
+      @hsh_nest = { a: 1, b: 2, c: 3, d: { e: 4 } }
+      @hsh_nest_n = { a: 1, b: 2, c: 3, d: { e: 4, f: { g: 5 } } }
+    end
+
+    it 'with 0 nest level' do
+      @hsh_normal.extend(Normalize)
+      expect(@hsh_normal.a).to eql(1)
+      expect(@hsh_normal.b).to eql(2)
+      expect(@hsh_normal.c).to eql(3)
+    end
+
+    it 'with 1 nest level' do
+      @hsh_nest.extend(Normalize)
+      expect(@hsh_nest.d.e).to eql(4)
+    end
+
+    it 'with n nest level' do
+      @hsh_nest_n.extend(Normalize)
+      expect(@hsh_nest_n.d.e).to eql(4)
+      expect(@hsh_nest_n.d.f).to eql(g: 5)
+      expect(@hsh_nest_n.d.f.g).to eql(5)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'emergency_number'
+require 'normalize'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow_localhost: true)
+
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.before(:each) do
+    # US
+    stub_request(:get, %r|http://emergencynumberapi.com/api/country/us/|)
+      .to_return(
+        status: 200,
+        body: File.open('./spec/fixtures/us_response.json', &:read),
+        headers: {}
+      )
+
+    # AQ
+    stub_request(:get, %r|http://emergencynumberapi.com/api/country/aq/|)
+      .to_return(
+        status: 200,
+        body: File.open('./spec/fixtures/aq_response.json', &:read),
+        headers: {}
+      )
+
+    # Invalid
+    stub_request(:get, %r|http://emergencynumberapi.com/api/country/foobar/|)
+      .to_return(
+        status: 200,
+        body: File.open('./spec/fixtures/invalid_response.json', &:read),
+        headers: {}
+      )
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: emergency_number
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Shayon Mukherjee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-25 00:00:00.000000000 Z
+dependencies: []
+description: Based on Emergency Number API. This ruby gem allows you to query the
+  API and get any emergency numbers for any country in the world.
+email:
+- dev@shayon.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- MIT-LICENSE
+- README.md
+- lib/emergency_number.rb
+- lib/emergency_number/version.rb
+- lib/normalize.rb
+- spec/emergency_number_spec.rb
+- spec/fixtures/aq_response.json
+- spec/fixtures/invalid_response.json
+- spec/fixtures/us_response.json
+- spec/normalize_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/shayonj/emergency_number
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Get any emergency numbers for any country in the world.
+test_files: []