york-bin-collection 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05451ceebf8d458827b64fbd6269bfebff27e91716a8c78684d73549df9ffdae
+  data.tar.gz: e968fe6fe813c4528beced7068c56836497e784e9e5eb30a3d7f7fd4ec387348
+SHA512:
+  metadata.gz: d852ef9738a06acf0731f943378a40a15b3673e2f775c7ef0fd22fd907c02d2392c8508d2053aca1fad826113231ab5eebbea6a5c159332f1212aa3ed7dfb6c3
+  data.tar.gz: '079c2d4d8b5ae5abc995da7010919a28e8c48c533db2290b08d02a92eac93c772c0072688a47220c3e5eadb001752feea079d4116e394caf4fa39ce94a596bb2'

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    york-bin-collection (1.0.0)
+      nokogiri (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  york-bin-collection!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Aaron Christiansen
+
+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 @@
+# York::Bin::Collection
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/york/bin/collection`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'york-bin-collection'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install york-bin-collection
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/york-bin-collection.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/york-bin-collection.rb

@@ -0,0 +1,107 @@
+require 'nokogiri'
+require 'open-uri'
+require 'cgi'
+require 'json'
+
+module YorkBinCollection
+  VERSION = '1.0.0'
+
+  CALENDARS_ENDPOINT = 'https://doitonline.york.gov.uk/BinsApi/Calendars/Index'
+  EXOR_ENDPOINT = 'https://doitonline.york.gov.uk/BinsApi/EXOR'
+
+  CollectionDates = Struct.new('CollectionDates', :recycling, :household, :garden)
+
+  ##
+  # Checks if a UPRN is syntatically valid; that is, if is a string is 
+  # alphanumeric. 
+  # According to the Ordinance Survey, UPRNs can be alphanumeric, although I
+  # have yet to find an example with alphabetic characters in.
+  # @param [String] uprn The string to validate as a UPRN number.
+  # @return [Boolean] True if the string is a syntatically valid UPRN, false
+  #   otherwise.
+  def self.valid_uprn?(uprn)
+    /[A-Za-z0-9]+/ === uprn || up
+  end
+
+  ##
+  # A hash of collection types, as keys in a CollectionDates object, to their
+  # 'friendly' names.
+  def self.collection_types
+    {
+      recycling: 'Recycling',
+      household: 'Household waste',
+      garden: 'Garden waste'
+    }
+  end
+
+  ##
+  # Given a valid UPRN in the City of York, returns an CollectionDates struct of
+  # dates each bin will be collected. The keys are :recycling, :household and
+  # :garden.
+  # @param [String] uprn A valid UPRN.
+  # @return [CollectionDates] The known waste collection dates.
+  def self.get_collection_dates(uprn)
+    raise ArgumentError, 'invalid uprn' unless valid_uprn?(uprn)
+    url = CALENDARS_ENDPOINT + "?uprn=#{uprn}"
+    document = Nokogiri::HTML(open(url))
+
+    # The format of the document is:
+    #   body
+    #     div.container-fluid
+    #       ~header~
+    #       div
+    #         div.col-xs-12 col-sm-3
+    #           h2: December 2018
+    #           div.row
+    #             div: Tue 04 
+    #             div: Household waste
+    #           ...
+    #           h2: January 2019
+    #           ...
+    #         div.col-xs-12 col-sm-3
+    #           h2: March 2019
+    #           ...
+    #         ...
+    
+    # Let's start by getting the div which contains the columns, and flatten out
+    # the structure to get rid of them
+    collection_date_elements = []
+    document.css('body > div.container-fluid > div > div.col-xs-12.col-sm-3').each do |col|
+      collection_date_elements.push(*col.children)
+    end
+
+    collection_dates = CollectionDates.new([], [], [])
+    current_heading = nil
+
+    collection_date_elements.each do |row_or_heading|
+      if row_or_heading.name == "h2"
+        current_heading = row_or_heading.text
+      else
+        raise 'format error: didn\'t encounter heading before date' unless current_heading
+
+        day, kind = row_or_heading.children.map(&:text)
+        date = Date.parse("#{day} #{current_heading}")
+        key = collection_types.rassoc(kind)&.first
+        raise "unknown collection kind #{kind}" unless kind
+
+        collection_dates.send(key) << date
+      end
+    end
+
+    collection_dates
+  end
+
+  ##
+  # Given a postcode, returns a hash of UPRNs in that postcode to their house
+  # addresses.
+  # @param [String] postcode A valid postcode, which is permitted to include
+  #   a space.
+  # @param [Hash] A hash of UPRNs to short addresses for the property. If the
+  #   postcode is invalid, this may be blank.
+  def self.get_uprns_for_postcode(postcode)
+    url = "#{EXOR_ENDPOINT}/getPropertiesForPostCode?postcode=#{CGI.escape(postcode)}"
+    JSON.parse(open(url).read).map do |property|
+      [property['Uprn'].to_s, property['ShortAddress']]
+    end.to_h
+  end
+end

data/york-bin-collection.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "york-bin-collection"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Aaron Christiansen"]
+  spec.email         = ["aaronc20000@gmail.com"]
+
+  spec.summary       = "Scraper for the City of York Council Bin Collection page"
+  spec.homepage      = "https://github.com/Aaronc81/york-bin-collection"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Aaronc81/york-bin-collection"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "nokogiri", "~> 1.10"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: york-bin-collection
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Christiansen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: 
+email:
+- aaronc20000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/york-bin-collection.rb
+- york-bin-collection.gemspec
+homepage: https://github.com/Aaronc81/york-bin-collection
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Aaronc81/york-bin-collection
+  source_code_uri: https://github.com/Aaronc81/york-bin-collection
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Scraper for the City of York Council Bin Collection page
+test_files: []