beer_me 0.1.0

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: d5be08849008dcadb86169f661cca5e98e577116
4
+ data.tar.gz: 6c7f63058626a8362cf975ac1540ca415bb0058a
5
+ SHA512:
6
+ metadata.gz: 1aad4df4e82c09fe04c3d15997e6b87b03e80b9fc2275f3973d0208fa8dd0067c8d8df7765c07f7200694c3d89e1167a8be76af7ddf911ce0909d61d433d6d29
7
+ data.tar.gz: 7fef12c639e42d3809288fb32d2c99cd89f2d4335bab732a919ebd9a84293ff8f63ddbd10aa7f48fabb305e3a1c93854339d6e441d02b354d92487429088e5e9
data/.gitignore ADDED
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.1.0
5
+ before_install: gem install bundler -v 1.14.6
@@ -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 lguzman@me.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,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in beer_me.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 leog7one
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,41 @@
1
+ How To Build a CLI Gem
2
+
3
+ 1. Plan Your gem, imagine your interface
4
+
5
+ 2. Start with Project Stucture - Google(bundler)
6
+
7
+ 3. Start with entry point - the 'run' file.
8
+
9
+ 4. force that to build the CLI Interface
10
+
11
+ 5. Stub out the interface
12
+
13
+ 6. Start making things real
14
+
15
+ 7. Discover Objects
16
+
17
+ 8. Program
18
+
19
+ - A command line interface for top beers of the month from ratebeer.com
20
+ - user types beer-me
21
+ - returns list of beers
22
+
23
+ - user chooses number for info on beer
24
+ - shows beer style, score and number of reviews
25
+
26
+
27
+ what is a beer?
28
+
29
+ Beer has a name
30
+ Beer has style
31
+ Beer has score
32
+ Beer has reviews
33
+
34
+ ISSUES:
35
+
36
+ (ISSUE RESOLVED): As of 6/28/17, have one issue left.
37
+ - When entering a number not on the list, the error "undefined method `css' for nil:NilClass (NoMethodError)" comes up.
38
+ Need to find way to make it state : please choose a valid number fir more info.
39
+
40
+ (ISSUE RESOLVED): As of 6/28/17,
41
+ - When exiting it states to choose a valid number before exiting program. Need to take that out as just have it exit.
data/README.md ADDED
@@ -0,0 +1,48 @@
1
+ # BeerMe
2
+
3
+ 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/beer_me`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'beer_me'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install beer_me
22
+
23
+ ## Usage
24
+
25
+ In the command line you can run 'bin/beer-me'
26
+ This will generate a list scraped from Ratebeer.com of the top 50 NEW beers of the month.
27
+ Select the number of the beer you would like more info on and the style, score and number of reviews will apeear.
28
+ To bring up the list again type "list"
29
+ If a number is chosen that is not on the list the application will ask you to choose a valid number.
30
+ To exit the app, type "exit"
31
+
32
+ HAPPY TASTING!
33
+
34
+ ## Development
35
+
36
+ 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.
37
+
38
+ 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).
39
+
40
+ ## Contributing
41
+
42
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/beer_me. 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.
43
+
44
+
45
+ ## License
46
+
47
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
48
+
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/beer_me.gemspec ADDED
@@ -0,0 +1,39 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'beer_me/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "beer_me"
8
+ spec.version = BeerMe::VERSION
9
+ spec.authors = ["leog7one"]
10
+ spec.email = ["lguzman@me.com"]
11
+
12
+ spec.summary = %q{BeerMe CLI is a gem that gets the Top New Beers of the Month and provides info on the beers}
13
+ spec.description = %q{Write a longer description or delete this line.}
14
+ spec.homepage = "http://github.com"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ # if spec.respond_to?(:metadata)
20
+ # spec.metadata['allowed_push_host'] = "Set to 'http://mygemserver.com'"
21
+ # else
22
+ # raise "RubyGems 2.0 or newer is required to protect against " \
23
+ # "public gem pushes."
24
+ # end
25
+
26
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
27
+ f.match(%r{^(test|spec|features)/})
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_development_dependency "bundler", "~> 1.14"
34
+ spec.add_development_dependency "rake", "~> 10.0"
35
+ spec.add_development_dependency "rspec", "~> 3.0"
36
+ spec.add_development_dependency "pry"
37
+
38
+ spec.add_dependency "nokogiri"
39
+ end
data/bin/beer-me ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+
3
+
4
+ #when first creating the file, we need to give it permission to be executed.
5
+ #if we tried running ./bin/beer-me we will get an 'permission denied' error in terminal
6
+ #To give permission we need to change them using 'chmod +x beer-me' in bin/
7
+ #puts "Hello World!"
8
+
9
+
10
+ require "bundler/setup"
11
+ require "beer_me"
12
+
13
+ # We do not want the actual CLI in the bin file.
14
+ # We have a class called CLI that we instaniate and can create a call method that will start the program
15
+ BeerMe::CLI.new.call
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "beer_me"
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/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,44 @@
1
+ class BeerMe::Beer
2
+ attr_accessor :name
3
+
4
+ #set the inital value of beers to be an empty array that can hold the beers
5
+ @@beers = []
6
+
7
+ def initailize
8
+ @@beers << self
9
+
10
+ end
11
+
12
+ def self.all
13
+ @@beers
14
+ end
15
+
16
+ def self.scrape_beers_site
17
+ #obtaions the page from ratebeer as nokogiri elements
18
+ doc = Nokogiri::HTML(open("https://www.ratebeer.com/Ratings/TopOfTheMonth.asp"))
19
+
20
+ #List the beers of the month
21
+ #Use 'tr' to get th rows that contains the info for each beer
22
+ #each row is an array of items
23
+ #the name of the beer is the [1] element
24
+ beer_rows = doc.css('tr')
25
+ index = 0
26
+ beer_rows.each_with_index do |row, i|
27
+ beer = BeerMe::Beer.new
28
+ beer.name = row.css('td')[1].text
29
+ #since the iteration will bring back the first row and that row has no info we want to skip the first one
30
+ #the index of 0 we will skip it using 'next' and then put the rest as those are the beers.
31
+ if i == 0
32
+ next
33
+ end
34
+ puts "#{i}. #{beer.name}"
35
+ end
36
+ end
37
+
38
+ def self.scrape_beer_info
39
+ #scrapes the table and only gets the info from the rows
40
+ doc = Nokogiri::HTML(open("https://www.ratebeer.com/Ratings/TopOfTheMonth.asp"))
41
+
42
+ beer_rows = doc.css("tr")
43
+ end
44
+ end
@@ -0,0 +1,63 @@
1
+ #CLI Controller
2
+
3
+ class BeerMe::CLI
4
+
5
+ def call
6
+ doc = Nokogiri::HTML(open("https://www.ratebeer.com/Ratings/TopOfTheMonth.asp"))
7
+ month_title = doc.css("h1").text
8
+ puts ""
9
+ puts "*****************************************"
10
+ puts "******** " + month_title + "*********"
11
+ puts "*****************************************"
12
+ puts ""
13
+
14
+ list_beers
15
+ menu
16
+ beer_info
17
+ goodbye
18
+ end
19
+
20
+ def list_beers
21
+ @@beers = BeerMe::Beer.scrape_beers_site
22
+ end
23
+
24
+ def beer_info
25
+ @@info = BeerMe::Beer.scrape_beer_info
26
+ end
27
+
28
+ def menu
29
+ input = nil
30
+ while input != 'exit'
31
+ puts ""
32
+ puts "Enter beer number to display Beer Info or type 'list' to see the list again or type 'exit':"
33
+ input = gets.strip.downcase
34
+
35
+ if input.to_i > 0 && input.to_i < beer_info.length
36
+ #grabs the row based on input number and pulls the info for style, score and review number using nokogiri.
37
+ info = beer_info[input.to_i]
38
+ beer_style = info.css('td')[4].text
39
+ beer_score = info.css('td')[2].text
40
+ beer_reviews = info.css('td')[3].text
41
+
42
+ puts "Beer Style: #{beer_style}"
43
+ puts "Beer Score: #{beer_score}"
44
+ puts "Beer Reviews: #{beer_reviews}"
45
+
46
+ elsif input == "list"
47
+ list_beers
48
+
49
+ elsif input == "exit"
50
+
51
+ elsif
52
+ puts "Please choose a valid number."
53
+
54
+
55
+ end
56
+ end
57
+ end
58
+
59
+ def goodbye
60
+ puts "See you next month for the new best beers!"
61
+ end
62
+
63
+ end
@@ -0,0 +1,3 @@
1
+ module BeerMe
2
+ VERSION = "0.1.0"
3
+ end
data/lib/beer_me.rb ADDED
@@ -0,0 +1,10 @@
1
+ #beer_me.rb will require the files for the program
2
+ #Acts as the environment
3
+
4
+ require "pry"
5
+ require "nokogiri"
6
+ require "open-uri"
7
+
8
+ require_relative "beer_me/version"
9
+ require_relative "./beer_me/beer"
10
+ require_relative './beer_me/cli'
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
+ created a CLI using dummy info to make sure the app worked at first. Once the app was able to run using the dummy info, I went to scraping the ratebeer.com site using nokogiri
6
+ - [x] Pull data from an external source
7
+ Data pulled from RateBeer.com using nokogiri, data is updated daily as new beers get reviewed. This data refreshes back to nothing every month so it may be empty for the first few days of every month
8
+ - [X] Implement both list and detail views
9
+ The list view for the beers was generated by iterating through the table rows of all the beers and grabbing the name using array[i] as there were 5 items per each row and the name was item 1.
10
+
metadata ADDED
@@ -0,0 +1,133 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: beer_me
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - leog7one
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-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.14'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.14'
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: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: nokogiri
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: Write a longer description or delete this line.
84
+ email:
85
+ - lguzman@me.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - LICENSE.txt
96
+ - NOTES.md
97
+ - README.md
98
+ - Rakefile
99
+ - beer_me.gemspec
100
+ - bin/beer-me
101
+ - bin/console
102
+ - bin/setup
103
+ - lib/beer_me.rb
104
+ - lib/beer_me/beer.rb
105
+ - lib/beer_me/cli.rb
106
+ - lib/beer_me/version.rb
107
+ - spec.md
108
+ homepage: http://github.com
109
+ licenses:
110
+ - MIT
111
+ metadata: {}
112
+ post_install_message:
113
+ rdoc_options: []
114
+ require_paths:
115
+ - lib
116
+ required_ruby_version: !ruby/object:Gem::Requirement
117
+ requirements:
118
+ - - ">="
119
+ - !ruby/object:Gem::Version
120
+ version: '0'
121
+ required_rubygems_version: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ requirements: []
127
+ rubyforge_project:
128
+ rubygems_version: 2.6.11
129
+ signing_key:
130
+ specification_version: 4
131
+ summary: BeerMe CLI is a gem that gets the Top New Beers of the Month and provides
132
+ info on the beers
133
+ test_files: []