austin_crime 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dec53207ca2de87e995280b343a7a5ec3985311
+  data.tar.gz: 0b3e6aace345367d608b3471a66bae7054397926
+SHA512:
+  metadata.gz: 526bfc5e9c64181fb29d3cfbde39feadbc0de7215c85ad8f6890f770b72c2968e943f9292e3d09b28d68ae10a189231f91f4a0546f93ba10734142eb25bd4e0b
+  data.tar.gz: 2f6924f4a1692eeb795f59f375adbf8a63646e61dd1b382f5821a6063adc52df17e50b176a5d84cce3f7b5f3e5e3337945a68f2ffcd2e82d7706944c898a61fe

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.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 tracypholmes@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 austin_crime.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tracy Holmes
+
+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/NOTES.md

@@ -0,0 +1,130 @@
+How to Build a CLI Gem
+
+
+    Planning the Gem
+    Beginning the Gem building process
+        Setting up or generating the basic structure of the Gem
+        Creating and stubbing out the executable file
+    requiring files - require and require_relative
+    Coding the CLI Class - our Controller
+        Stubbing out the CLI Class with hardcoded return data - here doc
+        Creating the menu
+    Setting up our Deal Class
+        Today method to return todays deals
+        stubbing out our first deal instances with hardcoded data
+        setting up the deal class attributes
+    Testing our data in console
+    wire our menu with conditional to work with our deals array
+        iterate and display deals
+        fix spelling on availability
+    Setting up our scraper class - Deal class method or individual class?
+        set up Deals#scrape_deals method
+    Adding gem dependencies to the app
+        Add dependecies to gemspec
+        development dependencies or regular dependencies
+    code individual scrape methods for each site
+        Use css selectors to scrape desired information
+        create new deal object and set it's attributes based on scraped info
+        logic for availability
+    final thoughts and tips on building process
+
+
+1. Plan your gem, imagine your interface
+2. Start with the project structure - google is your friend
+  a. Bundler - creating a gem guide
+3. Start with the entry point - the file run
+  a. remember `#!/usr/bin/env ruby`
+4. force that to build the CLI interface
+  a. Build the code you wish you had! start with ATXCrime::CLI.new.call in bin
+5. stub out the interface
+  a. build `call` class | cli.rb | class ATXCrime::CLI
+6. start making things real
+7. discover objects.
+8. program
+
+
+* Needed Gems: thor, pry, httparty, soda-ruby (instead of httparty?)
+* OpenData Socrata How-To: https://dev.socrata.com/consumers/getting-started.html
+* URL: https://data.austintexas.gov/Public-Safety/APD-Incident-Extract-YTD/b4y9-5x39
+* About the Dataset: https://dev.socrata.com/foundry/data.austintexas.gov/rkrg-9tez
+* API Endpoint: https://data.austintexas.gov/resource/rkrg-9tez.json
+
+Fields  | Field Names    
+------------ | ------------
+Incident Report Number | incident_report_number
+Crime Type | crime_type
+Date | date
+Time | time
+LOCATION_TYPE | location_type
+ADDRESS | address
+LONGITUDE | longitude
+LATITUDE | latitude
+Location 1 | location_1
+
+-------------
+limit this to ONLY 5 crime types.
+User can put in a number and get a list of the crimes
+> so, basically, my crime types list is kinda like WIN_COMBINATIONS? Well no. I literally just need to add the list in the cli, then link it to the api for that specific type (sorry for talking at you, but you are usually very honest with me especially if i'm not on the right track lol)
+
+
+  limit crimes to only 5
+
+
+
+[21:38]  
+the user puts in a number and gets a list of the crimes
+
+- A command line interface for for residents to view crime reports.
+
+
+### What is a crime?
+  A crime has a crime type
+  A crime has a date
+  A crime has an incident report number
+
+
+user types austin_crime
+
+Welcome to AustinCrime!
+
+1. DWI
+2. HARASSMENT
+3. CRUELTY TO ANIMALS
+4. THEFT
+5. CRIMINAL MISCHIEF
+
+Please enter the number next to the crime type for more information:
+https://data.austintexas.gov/resource/rkrg-9tez.json?$where=starts_with(crime_type,'#{type}')&$limit=10&$offset=0]
+
+Ideally this would show a list of incident_report_number for the specific crime_type
+https://data.austintexas.gov/resource/rkrg-9tez.json?crime_type=" "&$limit=5&$offset=5
+# HOW DO I SHOW JUST THE DAMN IRN for crime_type?!
+User selects which report number they want to find out more about.
+Or user can type `more` to get more crimes in the list | or previous to see the previous list
+
+John Verdone [21:00] 
+You also probably don't need to do response =
+
+Tracy Holmes [21:00] 
+ahhh ok. I don't think I did it at the bottom. But i'm not using it to really store anything, so no reason to have it. :taking notes:
+
+John Verdone [21:02] 
+and a little *wink wink*.
+
+[21:02]  
+Store the information into objects.
+
+[21:03]  
+might save yourself a refactor step upon review.
+
+Tracy Holmes [21:03] 
+!!
+
+[21:03]  
+Okies!
+
+John Verdone [21:04] 
+It's a little inside info from the feed back I got from luke from my project.
+
+Tracy Holmes [21:05] 
+Thanks, John! I appreciate that

data/README.md

@@ -0,0 +1,42 @@
+# AustinCrime
+
+CLI gem that allows users to view Austin crime reports by crime type.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'austin_crime'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install austin_crime
+
+Run from terminal with:
+
+    austin_crime
+
+## Usage
+
+Run the gem and the program will provide you with 5 crime types. You can then type the number of the type you want to read more about and the terminal will display the one full result. If you want to view more, you can type 'more', and it will show you 10 full crimes. You can also type "List" to display the list of types again,  or "q" to quit the program.
+
+## 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/Tracy Holmes/austin_crime. 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](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/austin_crime.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'austin_crime/version'
+
+Gem::Specification.new do |s|
+  s.name          = "austin_crime"
+  s.version       = AustinCrime::VERSION
+  s.authors       = ["Tracy Holmes"]
+  s.email         = ["tracypholmes@gmail.com"]
+
+  s.summary       = %q{Simple command line tool to view Austin crime stats.}
+  s.description   = %q{View crime reports on specific crime types!}
+  s.homepage      = "https://github.com/tracypholmes/austin_crime"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir        = "bin"
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency  'thor', '~> 0'
+  s.add_dependency 'httparty', '~> 0'
+
+  s.add_development_dependency "bundler", "~> 1.14"
+  s.add_development_dependency "pry", "~> 0.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/austin_crime

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "austin_crime"
+
+AustinCrime::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "austin_crime"
+
+# 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/austin_crime/cli.rb

@@ -0,0 +1,57 @@
+require 'httparty'
+
+class AustinCrime::CLI
+  def initialize
+  #  @inputs = inputs
+  end
+
+  def call
+    puts 'Welcome to Austin Crime Search!'
+    inputs
+    menu
+    # cya
+  end
+
+  def inputs
+  #  inputs = ['DWI', 'HARASSMENT', 'CRUELTY TO ANIMALS', 'THEFT']
+    # Select type of crime to view
+    puts <<-DOC
+    1. DWI
+    2. HARASSMENT
+    3. CRUELTY TO ANIMALS
+    4. THEFT
+    DOC
+
+    # @crimes = AustinCrime::Crime.all
+    # @crimes.each.with_index(1) do |crime, i|
+    #   puts "#{i}. #{crime.type} - #{crime.increp} - #{crime.date}"
+    # end
+  end
+
+  def menu
+    input = 'nil'
+    while input != 'q'
+      puts "\nPlease enter the number of the crime type for more information. Or enter 'list' to see your list of options."
+      puts "You may also enter 'q' to Quit."
+      input = gets.strip.downcase
+    # if input.to_i > 0 && input.to_i < 5
+      # puts AustinCrime::Crime.all
+      case input
+      when '1'
+        puts AustinCrime::Crime.dwi
+      when '2'
+        puts AustinCrime::Crime.harassment
+      when '3'
+        puts AustinCrime::Crime.cruelty
+      when '4'
+        puts AustinCrime::Crime.theft
+      when 'q'
+        puts 'Thanks for visiting. Come again for more reasons NOT TO MOVE TO AUSTIN!'
+      when 'list'
+        inputs
+      else
+        puts "Need some help? Type 'list' to see your options or 'q' to quit."
+      end
+    end
+  end
+end

data/lib/austin_crime/crime.rb

@@ -0,0 +1,53 @@
+require 'httparty'
+require 'pry'
+
+class AustinCrime::Crime
+  def initialize
+    @response = response
+  end
+
+  def self.url
+    url = "https://data.austintexas.gov/resource/rkrg-9tez.json?$where=starts_with(crime_type,"
+  end
+
+  def self.dwi
+    @response = HTTParty.get(url + "'DWI')&$limit=10")
+    yeesh
+  end
+
+  def self.harassment
+    @response = HTTParty.get(url + "'HARASSMENT')&$limit=10")
+    yeesh
+  end
+
+  def self.cruelty
+    @response = HTTParty.get(url + "'CRUELTY TO ANIMALS')&$limit=10")
+    yeesh
+  end
+
+  def self.theft
+    @response = HTTParty.get(url + "'THEFT')&$limit=10")
+    yeesh
+  end
+
+  def self.yeesh
+    puts "Got #{@response.count} results. Showing first result:"
+    @response.first.each do |k, v|
+      puts "#{k}: #{v}"
+    end
+    puts "\nEnter 'more' if you'd like to browse more entries or 'menu' if you'd like to start over"
+    input = gets.chomp
+    if input == 'more'
+      @response.collect do |hash|
+        puts '--------------------'
+        hash.collect do |k, v|  # not supposed to use collect on hashes?
+          puts "#{k}: #{v}"
+        end.compact.reject(&:empty?) # c_cole on the assist
+      end
+    elsif input == 'menu'
+      AustinCrime::CLI.inputs
+    else
+      puts 'Not sure what you want. Please try again.'
+    end
+  end
+end

data/lib/austin_crime/version.rb

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

data/lib/austin_crime.rb

@@ -0,0 +1,3 @@
+require_relative "./austin_crime/version"
+require_relative './austin_crime/crime'
+require_relative './austin_crime/cli'

data/spec.md

@@ -0,0 +1,6 @@
+# Specifications for the CLI Assessment
+
+Specs:
+- [x] Have a CLI for interfacing with the application | cli present, interface presenting user with choices
+- [x] Pull data from an external source | utilizing OpenData from data.austintexas.gov
+- [x] Implement both list and detail views | user is able to list crime types and after choosing, see incident reports about them

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: austin_crime
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tracy Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: 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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: View crime reports on specific crime types!
+email:
+- tracypholmes@gmail.com
+executables:
+- austin_crime
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- NOTES.md
+- README.md
+- Rakefile
+- austin_crime.gemspec
+- bin/austin_crime
+- bin/console
+- bin/setup
+- lib/austin_crime.rb
+- lib/austin_crime/cli.rb
+- lib/austin_crime/crime.rb
+- lib/austin_crime/version.rb
+- spec.md
+homepage: https://github.com/tracypholmes/austin_crime
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Simple command line tool to view Austin crime stats.
+test_files: []