holidapi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2f73da6cef2ef3971334b6586327980710312b3
+  data.tar.gz: 92190d5e6dc25eb23da1ebd4b9aa29d209e9a402
+SHA512:
+  metadata.gz: 9233e616c2046171140b06bc5d7730ec90c7aafc6322836a738abf93321ffef4b54a5cbf263cd358366a00cdd7013037ee4b5b03bf33b5c9fe1fdf86e758f76e
+  data.tar.gz: 6cf5d325f9f088822f88018c910c5cb5906cee5610f094fcafab27ddc802ea2e2d859060a1ba12e648b178d4b4a846fde31e431fcf9ee268172566145f79e5b9

data/.gitignore

@@ -0,0 +1,42 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+# Ruby managers
+.rvmrc
+.ruby-version
+
+.rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brian Getting
+
+MIT License
+
+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,39 @@
+# HolidApi
+
+HolidApi is a Ruby gem that provides a wrapper for interacting with the [Holiday APi service](http://holidayapi.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'holidapi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install holidapi
+
+## Usage
+
+    require 'holidapi'
+
+    holidays = HolidApi.get
+
+The following options can also be used
+
+    holidays = HolidApi.get(country: 'gb', year: 2016, month: 1, day: 15)
+
+The gem defaults to `US` for the country, and the current year
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/holidapi/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/holidapi.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'holidapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "holidapi"
+  spec.version       = HolidApi::VERSION
+  spec.authors       = ["Brian Getting"]
+  spec.email         = ["brian@tatem.ae"]
+  spec.summary       = %q{A Ruby wrapper for the Holiday API service.}
+  spec.description   = %q{A Ruby wrapper for the Holiday API service.}
+  spec.homepage      = "http://github.com/tatemae-consultancy/holidapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'fakeweb', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'timecop', '~> 0.7'
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'json'
+end

data/lib/holidapi.rb

@@ -0,0 +1,76 @@
+require 'httparty'
+require 'json'
+require 'uri'
+require 'holidapi/version'
+
+module HolidApi
+  include HTTParty
+  
+  # Set the base_uri for HTTParty
+  base_uri 'http://holidayapi.com/v1'
+
+  # Set headers for HTTParty
+  headers({ 
+    'User-Agent' => "ruby-holidapi-#{VERSION}",
+    'Content-Type' => 'application/json; charset=utf-8',
+    'Accept-Encoding' => 'gzip, deflate'
+  })
+
+  class << self
+    
+    # Get the holidays from the API.
+    # Default country: "US"
+    # Default year: Time.now.year
+    #
+    # @param [Hash] options URI parameters
+    # @options [String] country ISO 3166-1 alpha-2 format (BE, GB or US)
+    # @options [Integer] year ISO 8601 format (YYYY)
+    # @options [Integer] month
+    # @options [Integer] day
+    #
+    # @see http://holidayapi.com
+    #
+    # @example
+    #   holidays = HolidApi.get
+    #   next_year = HolidApi.get(year: 2016)
+    #   england = HolidApie.get(country: 'gb')
+    #
+    def get(params = {})
+      opts = { country: 'us', year: Time.now.year }
+      query = URI.encode_www_form(opts.merge(params))
+      handle_response super('/holidays', query: query)
+    end
+
+    # Handle the response from the API
+    #
+    # @nodoc
+    #
+    def handle_response(response)
+      case response.code.to_i
+      when 200
+        JSON.parse(response)['holidays']
+      when 400
+        raise BadRequest.new response.parsed_response
+      when 401
+        raise Unauthorized.new
+      when 404
+        raise NotFound.new
+      when 400...500
+        raise ClientError.new response.parsed_response
+      when 500...600
+        raise ServerError.new
+      else
+        response
+      end
+    end
+  end
+
+  # Error classes
+  class ClientError < StandardError; end
+  class ServerError < StandardError; end
+  class BadRequest < StandardError; end
+  class Unauthorized < StandardError; end
+  class NotFound < StandardError; end
+  class Unavailable < StandardError; end
+
+end

data/lib/holidapi/version.rb

@@ -0,0 +1,3 @@
+module HolidApi
+  VERSION = "0.0.1"
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'holidapi'

data/spec/fixtures/holidays.json

@@ -0,0 +1,27 @@
+{  
+  "this_year": {
+    "status": 200,
+    "holidays": {
+      "2015-01-01": [
+        {
+          "name": "New Year\u2019s Day",
+          "country": "US",
+          "date": "2015-01-01"
+        }
+      ]
+    }
+  },
+
+  "next_year": {
+    "status": 200,
+    "holidays": {
+      "2016-01-01": [
+        {
+          "name": "New Year\u2019s Day",
+          "country": "US",
+          "date": "2016-01-01"
+        }
+      ]
+    }
+  }
+}

data/spec/holidapi/holidapi_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe HolidApi do
+  it 'sets the base_uri for HTTParty' do
+    expect(HolidApi.base_uri).to eq('http://holidayapi.com/v1')
+  end
+
+  it 'sets the headers for HTTParty' do
+    headers = {
+      "User-Agent"      => "ruby-holidapi-#{HolidApi::VERSION}",
+      "Content-Type"    => "application/json; charset=utf-8",
+      "Accept-Encoding" => "gzip, deflate"
+    }
+    expect(HolidApi.headers).to eq(headers)
+  end
+
+  context 'usage' do
+    before :each do
+      @fixtures = JSON.parse(File.read('spec/fixtures/holidays.json'))  
+    end
+
+    it 'returns the holidays' do
+      fixture = @fixtures['this_year']
+      register_fake_uri(fixture, country: 'us', year: 2015)
+      h = HolidApi.get
+      expect(h.keys.first).to eq(fixture['holidays'].keys.first)
+    end
+
+    it 'accepts params' do
+      fixture = @fixtures['next_year']
+      register_fake_uri(fixture, country: 'gb', year: 2016, month: 1, day: 1)
+      h = HolidApi.get(country: 'gb', year: 2016, month: 1, day: 1)
+      expect(h.keys.first).to eq(fixture['holidays'].keys.first)
+    end
+  end
+
+  context 'error handling' do
+    before :each do
+      @params = { country: 'us', year: 2015 }
+    end
+    it 'handles 400 errors' do
+      register_fake_uri('', @params, ['400', 'Bad Request'])
+      expect{ HolidApi.get }.to raise_error(HolidApi::BadRequest)
+    end
+
+    it 'handles 401 errors' do
+      register_fake_uri('', @params, ['401', 'Unauthorized'])
+      expect{ HolidApi.get }.to raise_error(HolidApi::Unauthorized)
+    end
+
+    it 'handles 404 errors' do
+      register_fake_uri('', @params, ['404', 'Not Found'])
+      expect{ HolidApi.get }.to raise_error(HolidApi::NotFound)
+    end
+    
+    it 'handles generic 400 errors' do
+      register_fake_uri('', @params, ['450', 'Who Knows'])
+      expect{ HolidApi.get }.to raise_error(HolidApi::ClientError)
+    end
+
+    it 'handles generic 400 errors' do
+      register_fake_uri('', @params, ['500', 'Server Error'])
+      expect{ HolidApi.get }.to raise_error(HolidApi::ServerError)
+    end
+
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'fakeweb'
+require 'pry'
+require 'timecop'
+require 'holidapi'
+
+# Do not allow real HTTP connections during testing
+FakeWeb.allow_net_connect = false
+
+# Clean the FakeWeb registry before each test
+RSpec.configure do |config|
+  config.before(:each) do
+    FakeWeb.clean_registry
+    Timecop.freeze(Time.local(2015))
+  end
+end
+
+# Register a fake URI with Fakeweb, and return fixture data
+#
+# @param [Object] fixture The fixture to return as JSON
+# @param [Hash] params The query params to include in the URI
+#
+# @example
+#   fixture = @fixtures['this_year']
+#   register_fake_uri(fixture, country: 'us', year: 2015)
+#
+def register_fake_uri(fixture, params = {}, status = ['200', 'OK'])
+  FakeWeb.register_uri(
+    :get,
+    "#{HolidApi.base_uri}/holidays?#{URI.encode_www_form(params)}",
+    body: fixture.to_json,
+    status: status
+  )
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: holidapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Getting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: A Ruby wrapper for the Holiday API service.
+email:
+- brian@tatem.ae
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- holidapi.gemspec
+- lib/holidapi.rb
+- lib/holidapi/version.rb
+- rails/init.rb
+- spec/fixtures/holidays.json
+- spec/holidapi/holidapi_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/tatemae-consultancy/holidapi
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Holiday API service.
+test_files:
+- spec/fixtures/holidays.json
+- spec/holidapi/holidapi_spec.rb
+- spec/spec_helper.rb