NewKS 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 397314819dc981911b4ba46b74b94bce5d281b2b
+  data.tar.gz: 9c7ef3ac6468f7fbee6eb345d25a68a36d49aff8
+SHA512:
+  metadata.gz: 55be44f23d2234658a5b83d9da68e0ec88ff07ae348f2d79609a4eb9b35ed1aa58fa17a6530b1c1a93be3a32c1461fd93de5b40d9e155331697bf6afb629d6e0
+  data.tar.gz: 72b8e54335865d4a1d63211b0596b44d218a51b71d90639e7dd336888f4a4ff3bb68625efd24224e0fa4d940cac0cebfa3e2e71d29d564535cdf0b1b695f181b

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at ishmaelkhalid@icloud.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in NewKS.gemspec
+
+gem 'NewKS'

data/Gemfile.lock

@@ -0,0 +1,19 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    NewKS (0.1.2)
+      nokogiri
+    mini_portile2 (2.1.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    pkg-config (1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  NewKS
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 IshmaelKhalid
+
+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/NewKS.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'NewKS/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "NewKS"
+  spec.version       = NewKS::VERSION
+  spec.authors       = ["IshmaelKhalid"]
+  spec.email         = ["ishmaelkhalid@icloud.com"]
+
+  spec.summary       = %q{Scrapes top 20 new projects from kickstarter.com, an gives more info on each.}
+  spec.description   = %q{This ruby gem is a simple command line interface (CLI) to access the top 20 newest projects on Kickstarter.com.This gem also allows you to recieve basic information about those projects and a link to their project page.}
+  spec.homepage      = "https://github.com/IshmaelKhalid/NewKS"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["NewKS"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+
+  spec.add_dependency "nokogiri"
+end

data/README.md

@@ -0,0 +1,40 @@
+# NewKS - A revision of newest_kickstarter gem
+
+https://rubygems.org/gems/NewKS
+
+This ruby gem is a simple command line interface (CLI) to access the top 20 newest projects on Kickstarter.com.This gem also allows you to recieve basic information about those projects and a link to their project page.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'NewKS'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install NewKS
+
+## Usage
+
+Use this gem to study ruby techniques or just to keep up-to-date with your favorite KS Projects!
+
+## 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/IshmaelKhalid/newest_kickstarter. 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/NewKS

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# link to files that include NewestKickstarter::CLI.new.start method
+require_relative '../lib/NewKS'
+
+# Put here to avoid logic in bin folder
+NewKS::CLI.new.start

data/bin/console

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

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/config/environment.rb

@@ -0,0 +1,9 @@
+#This page was setup to make code easier to read and access, using standard folder structure (config) and descriptive file name (environment)
+
+require 'nokogiri' # for scraping kickstarter website
+require 'open-uri' # for scraping kickstarter website
+
+# require all files in lib directory
+require_relative '../lib/NewKS/version'
+require_relative '../lib/NewKS/project'
+require_relative '../lib/NewKS/cli'

data/lib/NewKS/cli.rb

@@ -0,0 +1,73 @@
+class NewKS::CLI
+  
+  def start # Dictates the flow and order of my gem  
+    list # Call Scraping Method
+    menu # Call Interactive Method
+    goodbye # Call Closing Method
+  end
+
+  def list # Scraping Method
+    puts "" #Skips Line
+    puts "************* (Top 20) Newest Kickstarter Projects *************" # List Title
+    puts "" #Skips Line
+    #Call .all method on Project Class, take each with index and puts
+    NewKS::Project.all.each.with_index(1) do |project, i|
+      puts "#{i}. #{project.name}" 
+      #format: 1. blahblah (then skips line, for each project)
+    end
+    puts "" #Skips Line
+  end
+
+  def menu # Interactive Method
+    input = nil # Define input for while method on next line
+    while input != "exit" #run this code unless user inputs exit
+      # Ask user for specific input
+      puts "Enter the number of the project you would like more info on, or type list for projects, or type exit"
+      #recieve user input, remove whitespace, and make lowercase
+      input = gets.strip.downcase
+      # Start Case Method based on user input
+      case input
+      when "list"
+        list # Run list method, then prompt question again
+      else #check if its a number, and add if statment
+        new_input = nil # Define new_input in case next line breaks
+        new_input = input.to_i # make user input a number
+        # check if user input a number between 1-20
+        if new_input.between?(1,20)
+          # take user input and run .find method on Project class
+          project = NewKS::Project.find(new_input)
+          # check if user input a number between 1-20 and i so
+          #run more_info method with an argument of the project
+          more_info(project)
+          # Then prompt question again
+        else # if user input is not a number between 1-20
+          puts "Oops!"
+          # Then prompt question again
+        end
+      end
+    end
+  end
+
+  def more_info(project)
+    puts "" #Skips Line
+    # Run .name method on searched project
+    puts "-------------- #{project.name} --------------" 
+    puts "" #Skips Line
+    # Run .summary method on searched project
+    puts project.summary
+    puts "" #Skips Line
+    # Run .author method on searched project
+    puts "Author: #{project.author}"
+    puts "" #Skips Line
+    # Run .url method on searched project
+    puts "URL: #{project.url}"
+    puts "" #Skips Line
+    # Then prompt question again
+  end
+
+  def goodbye # Closing Method
+    # Signal to the user that CLI has ended
+    puts "Thanks for stopping by. See you later for more projects!"
+  end
+
+end

data/lib/NewKS/project.rb

@@ -0,0 +1,51 @@
+class NewKS::Project
+  attr_accessor :name, :url, :summary, :author
+  # reader and writer methods for my project properties
+
+  # Initialize new projects with a name and url 
+  # Set to nil if not provided
+  def initialize(name = nil, url = nil)
+    # Set instance variables for project properties
+    @name = name
+    @url = url
+  end
+
+  def self.all
+    # fetch all projects if available or scrape KS
+    @@all ||= scrape_newest_projects
+  end
+
+  def self.find(id)
+    # find method that searches all projects by index
+    # [id-1] for offset, id starts @ 1, index starts @ 0
+    self.all[id-1]
+  end
+
+  def summary
+    # fetch summary if available or search doc and retrieve
+    @summary ||= doc.search("p.h3").text.strip
+  end
+
+  def author
+    # fetch author if available or search doc and retrieve
+    @author ||= doc.search('h5.mobile-hide a[data-modal-class="modal_project_by"]').text.strip
+  end
+
+  private
+    # scrape method for kickstarter projects
+    def self.scrape_newest_projects
+      # Set doc variable for all html scraped from KS Page
+      doc = Nokogiri::HTML(open('https://www.kickstarter.com/discover/advanced?recommended=false&sort=newest'))
+      # Set names variable for all project names scraped from doc
+      names = doc.search('h6.project-title a[data-score="null"]')
+      # iterate through names variable, collect name text, and url
+      # instantiate new project with name text and url for each pair
+      names.collect{|e| new(e.text.strip, "https://www.kickstarter.com#{e.attr("href").split("?").first.strip}")}
+      # Split at "?", take first part and remove whitespace
+    end
+
+    # Set doc variable for all html scraped from an objects url
+    def doc
+      @doc ||= Nokogiri::HTML(open(self.url))
+    end
+end

data/lib/NewKS/version.rb

@@ -0,0 +1,3 @@
+module NewKS
+  VERSION = "0.2.0"
+end

data/lib/NewKS.rb

@@ -0,0 +1,2 @@
+# require environment file where other requirements are stored
+require_relative '../config/environment'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: NewKS
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- IshmaelKhalid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: nokogiri
+  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'
+description: This ruby gem is a simple command line interface (CLI) to access the
+  top 20 newest projects on Kickstarter.com.This gem also allows you to recieve basic
+  information about those projects and a link to their project page.
+email:
+- ishmaelkhalid@icloud.com
+executables:
+- NewKS
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- NewKS-0.1.0.gem
+- NewKS-0.1.1.gem
+- NewKS-0.1.2.gem
+- NewKS.gemspec
+- README.md
+- Rakefile
+- bin/NewKS
+- bin/console
+- bin/setup
+- config/environment.rb
+- lib/NewKS.rb
+- lib/NewKS/cli.rb
+- lib/NewKS/project.rb
+- lib/NewKS/version.rb
+homepage: https://github.com/IshmaelKhalid/NewKS
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Scrapes top 20 new projects from kickstarter.com, an gives more info on each.
+test_files: []