shooting_match_finder 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 6127b18d9a6fb8845a052fdeddda8e1626880a2b
4
+ data.tar.gz: d140bd3aaa6dd5461f374fba0aebcbf92fbef1d3
5
+ SHA512:
6
+ metadata.gz: 4b3a33ed01d775ceac429ae22145ff961483ceb748d593ed3cb5f73ef3ac9e19ee6de27e999f258b1583648a250b5f7279053066bb7ae2c83bf750c3b8bf9744
7
+ data.tar.gz: 85bf449868e7c477fb994e33da7ffb054a3a50664e0d8f8476dcdb9ffb227addc45b0d51d02c14aa574597e843c0d6272d6f6a14699e8e3b58fa0e9e7db7e427
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at 'branden.mosley1337@gmail.com'. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in shooting_match_finder.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,30 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ shooting_match_finder (0.1.0)
5
+ nokogiri
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ coderay (1.1.2)
11
+ method_source (0.9.0)
12
+ mini_portile2 (2.3.0)
13
+ nokogiri (1.8.2)
14
+ mini_portile2 (~> 2.3.0)
15
+ pry (0.11.3)
16
+ coderay (~> 1.1.0)
17
+ method_source (~> 0.9.0)
18
+ rake (10.5.0)
19
+
20
+ PLATFORMS
21
+ ruby
22
+
23
+ DEPENDENCIES
24
+ bundler (~> 1.16)
25
+ pry
26
+ rake (~> 10.0)
27
+ shooting_match_finder!
28
+
29
+ BUNDLED WITH
30
+ 1.16.1
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 'Branden Mosley'
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/NOTES.md ADDED
@@ -0,0 +1,27 @@
1
+
2
+ shooting_match_finder
3
+
4
+ user types find matches
5
+
6
+ Show a list of matches
7
+
8
+ 1. 2018 Berry's Steel Open - Date
9
+ 2. SUPS Practical Pistol - Date
10
+ 3. Other match - date
11
+
12
+ Which match would you like to view?
13
+
14
+ user types 1 or exit or something
15
+
16
+ Display more information about the selected match
17
+
18
+ Berry's Steel Open, the date, the match description, location, entry fee
19
+
20
+ Match objects, What properties do they have?
21
+ A Match has a name, a date, a location, an entry fee, a description.
22
+
23
+ ----TO DO----
24
+
25
+ Build the Scraper class to pull information from Practiscore (Move #scrape_matches into Scraper class to test)
26
+ Build Scraper class methods that the Match class can use to instantiate new Match objects with attributes from Practiscore data.
27
+ Fix the CLI #menu method
data/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # ShootingMatchFinder
2
+
3
+ Welcome to Shooting Match Finder! This gem will give you a list of the top shooting matches happening around the country! You can also view specific details about any match, such as their cost, location, and start date. Thank you for using Shooting Match Finder!
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'shooting_match_finder'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install shooting_match_finder
20
+
21
+ ## Usage
22
+
23
+ Run: find-matches after installing the gem!
24
+
25
+ ## Development
26
+
27
+ 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.
28
+
29
+ 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).
30
+
31
+ ## Contributing
32
+
33
+ Bug reports and pull requests are welcome on GitHub at https://github.com/'Almighty-Mose'/shooting-match-finder. 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.
34
+
35
+ ## License
36
+
37
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
38
+
39
+ ## Code of Conduct
40
+
41
+ Everyone interacting in the ShootingMatchFinder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/'Almighty-Mose'/shooting_match_finder/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,2 @@
1
+ require "bundler/gem_tasks"
2
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "shooting_match_finder"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/find-matches ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "./lib/shooting_match_finder.rb"
5
+
6
+ ShootingMatchFinder::CLI.new.start
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,4 @@
1
+ require "shooting_match_finder/version"
2
+ require 'shooting_match_finder/cli'
3
+ require 'shooting_match_finder/match'
4
+ require 'shooting_match_finder/scraper'
@@ -0,0 +1,55 @@
1
+ class ShootingMatchFinder::CLI
2
+
3
+ BASE_PATH = "https://practiscore.com"
4
+
5
+ def start
6
+ create_matches
7
+ add_attributes_to_match
8
+ list_matches
9
+ menu
10
+ farewell
11
+ end
12
+
13
+ def create_matches #Scrapes and then passes an array of hashes to Match.rb
14
+ matches = ShootingMatchFinder::Scraper.scrape_matches(BASE_PATH + '/search/matches')
15
+ Match.new_from_practiscore(matches)
16
+ end
17
+
18
+ def add_attributes_to_match #Adds details to those newly created matches.
19
+ Match.show_matches.each do |match|
20
+ attributes = ShootingMatchFinder::Scraper.scrape_from_match_url(BASE_PATH + match.match_url)
21
+ match.add_attributes(attributes)
22
+ end
23
+ end
24
+
25
+ def list_matches #Lists out the created matches by iterating over Match @@all.
26
+ puts "Here are the matches in your area:"
27
+ Match.show_matches.each.with_index(1){|match, i| puts "#{i}. #{match.name}"}
28
+ end
29
+
30
+ def menu #Is able to show details about any match.
31
+ input = nil
32
+ while input != "exit"
33
+ puts "Enter a match number for more info, list to see matches, or type exit."
34
+ input = gets.strip
35
+ if input.to_i > 0 && input.to_i < Match.show_matches.length
36
+ puts ""
37
+ puts "#{Match.show_matches[input.to_i - 1].name}"
38
+ puts " Start Time: #{Match.show_matches[input.to_i - 1].match_start}"
39
+ puts " Location: #{Match.show_matches[input.to_i - 1].location}"
40
+ puts " Entry Fee: #{Match.show_matches[input.to_i - 1].entry_fee}"
41
+ puts " #{Match.show_matches[input.to_i - 1].description}"
42
+ puts ""
43
+ elsif input.downcase == "list"
44
+ list_matches
45
+ else
46
+ puts "Please enter a match number, or type exit."
47
+ end
48
+ end
49
+ end
50
+
51
+ def farewell #Says goodbye!
52
+ puts "Come back again for more matches!"
53
+ end
54
+
55
+ end
@@ -0,0 +1,23 @@
1
+ class Match
2
+ attr_accessor :name, :location, :entry_fee, :match_start, :description, :match_url
3
+
4
+ @@all = []
5
+
6
+
7
+ def initialize(match_hash) #takes in a hash to assign each match a name and a url for later use in #add_attributes.
8
+ match_hash.each {|key, value| self.send(("#{key}="), value)}
9
+ @@all << self
10
+ end
11
+
12
+ def self.new_from_practiscore(match_array) #Uses the hash array passed in by cli.rb to create matches.
13
+ match_array.each{|match_hash| Match.new(match_hash)}
14
+ end
15
+
16
+ def add_attributes(match_info) #takes in a hash and uses mass assignment to add match details.
17
+ match_info.each {|key, value| self.send(("#{key}="), value)}
18
+ end
19
+
20
+ def self.show_matches
21
+ @@all
22
+ end
23
+ end
@@ -0,0 +1,33 @@
1
+ require 'open-uri'
2
+ require 'nokogiri'
3
+
4
+ class ShootingMatchFinder::Scraper
5
+
6
+ BASE_PATH = "https://practiscore.com"
7
+
8
+ def self.scrape_matches(website_url) #This creates an array of hashes that we then use to create match objects.
9
+ doc = Nokogiri::HTML(open(website_url))
10
+ matches = doc.css(".list-group-item")
11
+ matches[0...51].collect do |match_details|
12
+ {:name => match_details.css(".searchMatchWebName").text.gsub("Open", "").gsub("Closed", "").strip,
13
+ :match_url => match_details.css("a").attr('href').text}
14
+ end
15
+ end
16
+
17
+ def self.scrape_from_match_url(match_url) #Used to add attributes to newly created match objects.
18
+ doc = Nokogiri::HTML(open(match_url))
19
+ #This logic is used to identify matches based on whether or not registration is open, since they need to scrape differently.
20
+ if !doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[1]').text.include?("Registration opens")
21
+ match_info = {:match_start => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[1]/strong').text.strip,
22
+ :location => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[2]').text.gsub("Location:", "").strip,
23
+ :entry_fee => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/dl/dd/text()').text.strip,
24
+ :description => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[3]').text}
25
+ else
26
+ match_info = {:match_start => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[2]/strong').text.strip,
27
+ :location => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[3]').text.gsub("Location:", "").strip,
28
+ :entry_fee => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/dl/dd/text()').text.strip,
29
+ :description => doc.xpath('//*[@id="psMainContainer"]/div[2]/div[3]/div[1]/p[4]').text}
30
+ end
31
+ end
32
+
33
+ end
@@ -0,0 +1,3 @@
1
+ module ShootingMatchFinder
2
+ VERSION = "0.1.1"
3
+ end
@@ -0,0 +1,30 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "shooting_match_finder/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "shooting_match_finder"
8
+ spec.version = ShootingMatchFinder::VERSION
9
+ spec.authors = ["'Branden Mosley'"]
10
+ spec.email = ["'branden.mosley1337@gmail.com'"]
11
+
12
+ spec.summary = "Find all the shooting competitions near you!"
13
+ spec.description = "This RubyGem presents a list of shooting competitions in your area by scraping
14
+ https://practiscore.com/search/matches"
15
+ spec.homepage = "https://github.com/Almighty-Mose/shooting-match-finder"
16
+ spec.license = "MIT"
17
+
18
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
19
+ f.match(%r{^(test|spec|features)/})
20
+ end
21
+ spec.bindir = "exe"
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ["lib"]
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.16"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "pry", "~> 0"
28
+
29
+ spec.add_runtime_dependency "nokogiri", "~> 0"
30
+ end
data/spec.md ADDED
@@ -0,0 +1,10 @@
1
+ # Specifications for the CLI Assessment
2
+
3
+ Specs:
4
+ - [x] Have a CLI for interfacing with the application
5
+ My application is able to show a list of matches, and then accept input from the user
6
+ to show information about a specific match. It is also capable of discerning valid input from invalid. The CLI also greets and says goodbye to the user.
7
+ - [x] Pull data from an external source
8
+ ShootingMatchFinder scrapes data from https://practiscore.com/search/matches, and also scrapes from each match's respective detail page.
9
+ - [x] Implement both list and detail views
10
+ The application has a list_matches method, which lists out all scraped matches in numerical order, and also a #menu method, which is what allows a user to select and view details of a specific match.
data/testfile.rb ADDED
@@ -0,0 +1 @@
1
+ #we are testing
metadata ADDED
@@ -0,0 +1,121 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shooting_match_finder
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - "'Branden Mosley'"
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-03-28 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: pry
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: nokogiri
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: |-
70
+ This RubyGem presents a list of shooting competitions in your area by scraping
71
+ https://practiscore.com/search/matches
72
+ email:
73
+ - "'branden.mosley1337@gmail.com'"
74
+ executables: []
75
+ extensions: []
76
+ extra_rdoc_files: []
77
+ files:
78
+ - ".gitignore"
79
+ - CODE_OF_CONDUCT.md
80
+ - Gemfile
81
+ - Gemfile.lock
82
+ - LICENSE.txt
83
+ - NOTES.md
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/find-matches
88
+ - bin/setup
89
+ - lib/shooting_match_finder.rb
90
+ - lib/shooting_match_finder/cli.rb
91
+ - lib/shooting_match_finder/match.rb
92
+ - lib/shooting_match_finder/scraper.rb
93
+ - lib/shooting_match_finder/version.rb
94
+ - shooting_match_finder.gemspec
95
+ - spec.md
96
+ - testfile.rb
97
+ homepage: https://github.com/Almighty-Mose/shooting-match-finder
98
+ licenses:
99
+ - MIT
100
+ metadata: {}
101
+ post_install_message:
102
+ rdoc_options: []
103
+ require_paths:
104
+ - lib
105
+ required_ruby_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ required_rubygems_version: !ruby/object:Gem::Requirement
111
+ requirements:
112
+ - - ">="
113
+ - !ruby/object:Gem::Version
114
+ version: '0'
115
+ requirements: []
116
+ rubyforge_project:
117
+ rubygems_version: 2.5.2.1
118
+ signing_key:
119
+ specification_version: 4
120
+ summary: Find all the shooting competitions near you!
121
+ test_files: []