newest_kickstarter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 260bf885f66c1571eb8736820d58d777f93c26b5
-  data.tar.gz: 0f73ba1c8c290b13a0d090cb3764d931d58776f4
+  metadata.gz: 3a9c2ac6553cc98c67a59461b4c72be6672d59d9
+  data.tar.gz: 71d7d1c86ce97b8801a0a2b0fd4eff38edde6380
 SHA512:
-  metadata.gz: 784970d62ec19afca903de1d004da0ebff9d1f9ed0351a53fecfba2b1d46374b0de8dcccb1812ff031abccfc9c421ad59afed32fae5c6672a29706b02d2abc6b
-  data.tar.gz: 8eaa092cf11766741804808e00f746e240993a63a297d649f9dc1c70c9d4dcb735e4c84bc2510330f276b5c2afdcd59e58d7b5615b7a60cd1c2a70ed3bbd41d9
+  metadata.gz: 0c4f2b50cc0e86772fc47ba2d944915b835f23f325c091b9b98780b9578f4e24ff48732490bdda7c42a89e3756120fee1163ae93d76eb2785f240fda9c445557
+  data.tar.gz: b7d96627e5b0059f7c520d173649c136c5c889cd9ed2d2fa7ce51e0692930446725513ddc59310c506eb39e7cb495a58c8f51159f885e10683253724678adef3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile2 (2.0.0)
+    newest_kickstarter (0.1.0)
+      nokogiri
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  newest_kickstarter
+
+BUNDLED WITH
+   1.11.2

data/NOTES.md

@@ -0,0 +1,14 @@
+A simple command line interface to access the top 20 newest kickstarter projects, and find basic info on them.
+
+source: https://www.kickstarter.com/discover/advanced?recommended=false&sort=newest
+
+Files Altered:
+newest-kickstarter
+environment.rb
+newest_kickstarter.rb
+cli.rb
+project.rb
+newest_kickstarter.gemspec
+Notes
+Readme
+

data/README.md

@@ -1,5 +1,7 @@
 # NewestKickstarter
 
+https://rubygems.org/gems/newest_kickstarter
+
 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

data/bin/newest-kickstarter

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

data/config/environment.rb

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

data/lib/newest_kickstarter/cli.rb

@@ -0,0 +1,73 @@
+class NewestKickstarter::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
+    NewestKickstarter::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 = NewestKickstarter::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/newest_kickstarter/project.rb

@@ -0,0 +1,52 @@
+class NewestKickstarter::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/newest_kickstarter/version.rb

@@ -1,3 +1,3 @@
 module NewestKickstarter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/newest_kickstarter.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   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      = "http://IshmaelKhalid.com"
+  spec.homepage      = "https://github.com/IshmaelKhalid/newest_kickstarter"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: newest_kickstarter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - IshmaelKhalid
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
@@ -75,18 +75,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
+- NOTES.md
 - README.md
 - Rakefile
 - bin/console
+- bin/newest-kickstarter
 - bin/setup
+- config/environment.rb
 - lib/newest_kickstarter.rb
+- lib/newest_kickstarter/cli.rb
+- lib/newest_kickstarter/project.rb
 - lib/newest_kickstarter/version.rb
+- newest_kickstarter-0.1.0.gem
 - newest_kickstarter.gemspec
-homepage: http://IshmaelKhalid.com
+- pkg/newest_kickstarter-0.1.0.gem
+homepage: https://github.com/IshmaelKhalid/newest_kickstarter
 licenses:
 - MIT
 metadata:

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/