nyc_dot_cctv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d2f9a0da147fa5ceff8d7071d6b1ebd2bf0f8038c51a2f176704ce6a1b828d6
+  data.tar.gz: 76cf5bc5efe7c613283133525a1b1a2d4490018d7aee7d6bf2f2378b8818337d
+SHA512:
+  metadata.gz: 4366e36b460b89d481f9aec10eb59908780f43568b929c8a0a928d53919efb157e087b20c579e2ba80a4f13fd2823a394acec4709f9f596aa2ef88acc567b41a
+  data.tar.gz: 91e2e9a4a1298d43a1ed1fee9e6259000554a44f2277b42120449873359a434d845d3b2312c662086ffd6589d5a2ab03c73d92754f3ab11731eeb9b9bdf0aa20

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.1

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 joerodrig3@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 nyc_dot_cctv.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    nyc_dot_cctv (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  nyc_dot_cctv!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 joerodrig
+
+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,70 @@
+# NycDotCctv
+
+The goal of this Gem is to provide a lightweight way to stream live NYCDOT camera feeds
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nyc_dot_cctv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nyc_dot_cctv
+
+## Usage
+
+### Capturing an image
+The public CCTV cameras accessed as individual `.jpg` images. When you have the ID of a CCTV, you can capture an image by running the following line:
+```ruby
+cctv_id = "259"
+NycDotCctv.request_image(cctv_id)
+```
+
+This request will return a response that contains a hash with the following types
+```json
+{
+  "body": "String",
+  "requested_at": "Datetime",
+  "status_code": "Integer",
+  "uri": "URI"
+}
+```
+
+The 'body' will contain the `.jpg` image returned from the CCTV camera
+if the request was successful. The 'requested_at' time is the time that the
+request was triggered. The 'status_code' is the HTTP response header returned from the request. The 'uri' is the url generated to make the request.
+
+### Obtaining a CCTV ID
+I'm working on a way to make this a bit easier, but right now there's a small process to obtain a CCTV ID
+
+1) Navigate to https://nyctmc.org/multiview2.php
+2) Select any cameras from the list that you're interested in
+3) Click View
+4) You should be viewing live CCTV footage from the selected cameras.
+5) Hover over each camera individually, right-click and click 'Inspect'(if you're on Chrome).
+6) Inspector should open up over an `img` tag. Look at the source and find the part where it says something like `/cctv254.jpg`. The `254` is the ID that you want to use
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/nyc_dot_cctv. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NycDotCctv project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nyc_dot_cctv/blob/master/CODE_OF_CONDUCT.md).

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 "nyc_dot_cctv"
+
+# 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/nyc_dot_cctv.rb

@@ -0,0 +1,73 @@
+require "nyc_dot_cctv/version"
+require 'net/http'
+
+module NycDotCctv
+  module_function
+
+  class Error < StandardError; end
+  DEFAULT_CAMERA_IP = "207.251.86.238".freeze
+  DEFAULT_OPTIONS = {
+    host: DEFAULT_CAMERA_IP,
+    img_type: "jpg".freeze,
+    port: "80".freeze
+  }
+
+  # @param cctv_id [String]
+  # @param custom_opts [Hash]
+  # @return [Hash]
+  def request_image(cctv_id, custom_opts: {})
+    current_time = Time.now.utc
+    if invalid_cctv_id?(cctv_id)
+      return {
+        errors: ["An invalid CCTV ID was provided"],
+        requested_at: current_time
+      }
+    end
+
+    uri = generate_uri(cctv_id, {custom_opts: custom_opts})
+    res = Net::HTTP.get_response(uri)
+    {
+      body: res.body,
+      requested_at: current_time,
+      status_code: res.code,
+      uri: uri
+    }
+  end
+
+  # Generates a URI to request an image from a specified CCTV camera
+  # The default options should work in most cases, but can be overridden.
+  # @param cctv_id [String]
+  # @param custom_opts [Hash]
+  # @return [URI]
+  def generate_uri(cctv_id, custom_opts: {})
+    opts = DEFAULT_OPTIONS.merge(custom_opts)
+    uri = "http://#{cctv_host(opts[:host])}" \
+          "/cctv#{cctv_id}.#{opts[:img_type]}" \
+          "?rand=#{Random.rand}:#{opts[:port]}"
+    URI(uri)
+  end
+
+  # Specifies the cctv_host to use. If a valid host isn't
+  # specified, the default host is returned
+  # @param host [String]
+  # @return [Boolean]
+  def cctv_host(host)
+    return DEFAULT_CAMERA_IP if invalid_host?(host)
+    host
+  end
+
+  # A host is invalid if it's not a string, or if it's empty.
+  # example: host = "google.com"
+  # @param host [String]
+  # @return [Boolean]
+  def invalid_host?(host)
+    !host.class.to_s.eql?("String") || host.empty?
+  end
+
+  # Determine whether a provided cctv_id is invalid
+  # @param cctv_id [String]
+  # @return [Hash]
+  def invalid_cctv_id?(cctv_id)
+    invalid_host?(cctv_id)
+  end
+end

data/lib/nyc_dot_cctv/version.rb

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

data/nyc_dot_cctv.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nyc_dot_cctv/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nyc_dot_cctv"
+  spec.version       = NycDotCctv::VERSION
+  spec.authors       = ["Joseph James-Rodriguez"]
+  spec.email         = ["joerodrig3@gmail.com"]
+
+  spec.summary       = %q{Ability to view and stream live NYC DOT Traffic feeds}
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nyc_dot_cctv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph James-Rodriguez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- joerodrig3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nyc_dot_cctv.rb
+- lib/nyc_dot_cctv/version.rb
+- nyc_dot_cctv.gemspec
+homepage: 
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Ability to view and stream live NYC DOT Traffic feeds
+test_files: []