beginning_open_source 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d0569c0a434023a4d38061c61defb296ca8b34a
+  data.tar.gz: 000938c955852253fbc125a7276ebee3171b68ec
+SHA512:
+  metadata.gz: 741e8cc28710aa921af43c5c9598681492108d5c3ebf2c7dcd841c59b8dcdc20cfa4a8249db71395bba018e9e95882aae176cb44e3ae223be4355707056d154c
+  data.tar.gz: fbafb65ac20be15e97bcd3e37370df65c58d96274cdbb304412d77a0cea6c3430cb4b1b4037b03d1c1d3ada8d2f15e0a76505dd06335c35050a8c963b568575f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/lib/secrets.rb
+/lib/this_will_be_secrets_file.rb

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Corey Morris
+
+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/README.md

@@ -0,0 +1,64 @@
+# BeginningOpenSource
+
+A tool to find beginner friendly open source issues to work on.
+
+**NOTE:** Unless you provide a github token to authenicate, your search results will only return repository descriptions and stars once per hour due to github api restrictions".  Please only generate a public token as this application only accesses public data.  Instructions to generate a github token are here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/ .
+
+###Other resources for finding beginner friendly open source projects*:
+
+http://www.agileventures.org/
+
+http://24pullrequests.com/projects
+
+https://contribulator.herokuapp.com/?language=Ruby
+
+http://www.codetriage.com/
+
+https://github.com/trending
+
+https://blog.newrelic.com/2014/05/05/open-source_gettingstarted/
+
+https://www.youtube.com/watch?v=IXnNgLmd6BM
+
+https://www.youtube.com/watch?v=0OQg42gSol4
+
+https://guides.github.com/activities/contributing-to-open-source/
+
+https://www.quora.com/How-can-I-contribute-to-open-source-software
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beginning_open_source'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install beginning_open_source
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/beginning_open_source. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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/beginning_open_source.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beginning_open_source/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "beginning_open_source"
+  spec.version       = BeginningOpenSource::VERSION
+  spec.authors       = ["Corey Morris"]
+  spec.email         = ["coreym247@gmail.com"]
+
+  spec.summary       = %q{A tool to find beginner friendly open source issues to work on.}
+  spec.description   = %q{A tool to find beginner friendly open source issues to work on.}
+  spec.homepage      = "https://github.com/c1505/beginning-open-source"
+  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.
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "httparty"
+
+
+end

data/bin/beginning-open-source

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require '../lib/beginning_open_source'
+BeginningOpenSource::CLI.new.call

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "beginning_open_source"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/beginning_open_source.rb

@@ -0,0 +1,11 @@
+require_relative "beginning_open_source/version"
+require_relative "beginning_open_source/github_api.rb"
+require_relative "beginning_open_source/issues.rb"
+
+
+require_relative "secrets.rb"
+require_relative "cli"
+
+require 'json'
+require 'httparty'
+# require 'pry' #just for development

data/lib/beginning_open_source/github_api.rb

@@ -0,0 +1,97 @@
+class BeginningOpenSource::GithubApi
+
+  #i am passing around variables.  might be better off using class variables.  
+	  @@array_of_issues = []
+
+  def self.get_issues(input_string) #still very long.  refactor
+      response = self.search_issues(input_string)
+
+      puts "Total Issue count matching #{input_string}:".blue + " #{response["total_count"]}".red
+
+      search_results = JSON.parse(response.body)["items"]
+
+      loaded_repo_count = 1
+      search_results.each do |issue| 
+          hash_of_issue = {}
+
+          issue_url_array = issue["html_url"].split("/")
+
+          hash_of_issue[:repo_name] = issue_url_array[4]
+          repo_string = "https://api.github.com/repos/#{issue_url_array[3]}/#{issue_url_array[4]}"
+          
+          hash_of_issue[:title] = issue["title"]
+          hash_of_issue[:labels] = (issue["labels"].map {|issue| issue["name"]})
+          hash_of_issue[:body] = issue["body"]
+          hash_of_issue[:html_url] = issue["html_url"]
+          hash_of_issue[:created_at] = issue["created_at"]
+          hash_of_issue[:repo_url] = repo_string
+
+          if loaded_repo_count > 10 
+            puts "loading #{loaded_repo_count}/30" 
+          end
+          loaded_repo_count += 1
+          
+          self.get_repository(issue_url_array[3], issue_url_array[4], hash_of_issue)
+
+          @@array_of_issues << hash_of_issue
+
+      end #end of each statement
+      @@array_of_issues
+       #there are pagination options.  
+       # right now it is only giving me 30 per page.  can go up to 100
+    end  #end of method
+
+    def self.search_issues(input_string)
+      if self.token == 'PASTE_TOKEN_HERE_AS_STRING' #doing this twice, but with a different url.  if i take in the url or have it set as a variable, i might be able to combine these
+        response = HTTParty.get("https://api.github.com/search/issues?q=label:\"#{input_string}\"+language:ruby+state:open&sort=created&order=desc")
+      else
+        response = HTTParty.get("https://api.github.com/search/issues?q=label:\"#{input_string}\"+language:ruby+state:open&sort=created&order=desc",
+          :headers => {
+                  "Authorization" => "token #{self.token}",
+                  "User-Agent" => self.agent
+                  })
+      end
+      response
+    end
+
+    def self.get_repository(user, repository, hash)
+          if self.token == 'PASTE_TOKEN_HERE_AS_STRING'
+            repo_json = HTTParty.get("https://api.github.com/repos/#{user}/#{repository}") 
+          else
+            repo_json = HTTParty.get(
+              "https://api.github.com/repos/#{user}/#{repository}", 
+              :headers => {
+                  "Authorization" => "token #{self.token}",   
+                  "User-Agent" => self.agent
+                  })
+          end
+          repo_parsed = JSON.parse(repo_json.body)
+          hash[:repo_description] = repo_parsed["description"]
+          hash[:stars] = repo_parsed["stargazers_count"]
+          hash
+    end
+
+end #end of class
+
+class String
+  #colorization
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def red
+    colorize(31)
+  end
+end

data/lib/beginning_open_source/issues.rb

@@ -0,0 +1,31 @@
+class BeginningOpenSource::Issues
+  attr_accessor :title, :html_url, :repo_name, :repo_description, :body, :stars, :created_at, :labels, :repo_url
+
+  @@all = []
+
+  @@starred = []
+
+  def initialize(issues_hash)
+    issues_hash.each {|key, value| self.send(("#{key}="), value)}
+    @@all << self
+    unless @stars == nil
+      if @stars > 0          
+      	@@starred << self
+      end
+    end
+  end
+
+  def self.create_from_collection(issues_array)
+    issues_array.each do |issue|
+      BeginningOpenSource::Issues.new(issue)
+    end
+  end
+
+  def self.all
+    @@all
+  end
+
+  def self.starred
+  	@@starred
+  end
+end

data/lib/beginning_open_source/version.rb

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

data/lib/cli.rb

@@ -0,0 +1,86 @@
+class BeginningOpenSource::CLI
+
+	def call
+		generate_secret_file
+		welcome
+		puts "**Caution**\n
+      If you don't provide a github token to authenicate, your search results will only return repository descriptions and stars once per hour due to github api restrictions".yellow
+		list_beginner_issues
+		search_issues
+		goodbye
+	end
+
+	def welcome
+		puts "Welcome to beginning open source!".blue
+		puts "Viewing open github issues labeled 'beginner' within the ruby language".blue
+		puts " "
+		puts "With this tool, you can find issues on github by label".blue
+	end
+
+	def generate_secret_file
+		File.open("../lib/this_will_be_secrets_file.rb", 'w'){|f| f.write("class BeginningOpenSource::GithubApi
+		  def self.token
+		    'PASTE_TOKEN_HERE_AS_STRING'
+		  end
+
+		  def self.agent
+		  	'PASTE_GITHUB_USERNAME_HERE_AS_STRING'
+		  end
+		end")}
+	end
+
+	def list_beginner_issues #by default, it will return issues in github repos with 1 star or more
+		get_and_print('beginner')
+	end
+
+	def search_issues
+		input = nil
+		while input != "exit"
+			puts "\n" + "Enter the issue label you would like to search for or type 'exit'".green
+			input = gets.chomp.scan(/[a-z\s]/).join
+			unless input == 'exit' 
+				get_and_print(input)
+			end
+			# list_issues #do i want to return all issues or just the last searched ones.  i'm thinking last searched
+		#possibly could store the other in memory to retrieve again if i want
+		end
+	end
+
+	def goodbye 
+		puts "Happy learning!"
+	end
+
+	def get_and_print(input_string)
+	issues_array = BeginningOpenSource::GithubApi.get_issues(input_string)
+	
+	BeginningOpenSource::Issues.create_from_collection(issues_array)
+	if BeginningOpenSource::Issues.starred.empty?
+		BeginningOpenSource::Issues.all.each do |issue|
+			length = "Repository Url: #{issue.repo_url}".length
+			puts " "
+			puts "Issue Title: #{issue.title}".blue
+			puts "Repository Name: #{issue.repo_name}"
+			puts "Repository Description: #{issue.repo_description}"
+			puts "Stars: #{issue.stars}"
+			puts "Labels: #{issue.labels}"
+			puts "Issue Url: #{issue.html_url}"
+			puts "Repository Url: #{issue.repo_url}"
+			length.times {print "*"}
+		end
+	else
+		BeginningOpenSource::Issues.starred.each do |issue|
+			length = "Repository Url: #{issue.repo_url}".length
+			puts " "
+			puts "Issue Title: #{issue.title}".blue
+			puts "Repository Name: #{issue.repo_name}"
+			puts "Repository Description: #{issue.repo_description}"
+			puts "Stars: #{issue.stars}"
+			puts "Labels: #{issue.labels}"
+			puts "Issue Url: #{issue.html_url}"
+			puts "Repository Url: #{issue.repo_url}"
+			length.times {print "*"}
+		end
+	end
+end
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: beginning_open_source
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Corey Morris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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'
+description: A tool to find beginner friendly open source issues to work on.
+email:
+- coreym247@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- beginning_open_source.gemspec
+- bin/beginning-open-source
+- bin/console
+- bin/setup
+- lib/beginning_open_source.rb
+- lib/beginning_open_source/github_api.rb
+- lib/beginning_open_source/issues.rb
+- lib/beginning_open_source/version.rb
+- lib/cli.rb
+homepage: https://github.com/c1505/beginning-open-source
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A tool to find beginner friendly open source issues to work on.
+test_files: []
+has_rdoc: