contribute 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18182ea53d8ed6c02f78b5451f1fe9cdf791ee62
-  data.tar.gz: a04fb247a0c7da8ca1cef0e7f9fbe3055115f5f0
+  metadata.gz: 6a81c281627bffc4e01efcd624f0675b7454e5c8
+  data.tar.gz: c742de3a5786dc061446a6de0a1431d024c4538c
 SHA512:
-  metadata.gz: 145d19cc251ade0084813d8236e7074c8b61106cdd0565fff8a5f852f71c7a9bbfa170c1d7a4715d37e98c9279b7d7e156b401ba90e3708487b911f728a72d23
-  data.tar.gz: d9171bf9a53ceae58d26df8e5b429edc5ecaf0d799b7e48474532205509410c5f30ad7a63e3c26e6a50533006f64e554acb77149907dccb4dbc3592c4c0fbeb1
+  metadata.gz: e26e990118a288d06b4c2cadfacab0eacf54a5ccff1b0ed5549aa1e7d2f01bdbb15b3febf26eb37febfeb4538d760ac0feba8f3ee282ac2116b6de69f74d6dfb
+  data.tar.gz: 43422079a7b29a06cf11eb80e6ecabd5aeda1c4a4a0f5c5e570ac57755caeb131984dc41f2e9fd910f1d57a0199bead5f663efb0c09c9a4e168ae492a5d1723d

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .token.yml
+contribute-0.1.0.gem

data/.rubocop.yml

@@ -0,0 +1,52 @@
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.0
+  Exclude:
+    - tmp/**/*
+    - lib/bundler/vendor/**/*
+  DisplayCopNames: true
+
+# Lint
+
+Lint/EndAlignment:
+  AlignWith: variable
+  AutoCorrect: true
+
+# Style
+Metrics/LineLength:
+  Max: 100
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: falses
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# We adopted raise instead of fail.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+# Having these make it easier to *not* forget to add one when adding a new
+# value and you can simply copy the previous line.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma

data/.rubocop_todo.yml

@@ -0,0 +1,7 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-12-28 19:43:39 +0530 using RuboCop version 0.46.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.

data/.token.yml.example

@@ -1,2 +1,2 @@
 token:
-  'your_github_token'
+  'your_github_token'

data/.travis.yml

@@ -2,4 +2,10 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.12.5
+before_install:
+  - gem install bundler -v 1.12.5
+  - cp .token.yml.example .token.yml
+  - echo -e "token:\n  $GITHUB_TOKEN" > ./.token.yml
+script:
+  - RAILS_ENV=test bundle exec rspec
+  - bundle exec rubocop

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in contribute.gemspec

data/README.md

@@ -3,6 +3,8 @@
 Have you been looking for open source reposotires to contribute? Look no further! You have come to right place. This gem will find active reposotries from github to eat away your weekend time. Say goodbay to fruitless late night research, tiring click surfing and the voice in your head which make you feel guilty for not doing enough. Be warned! Your life will never be same after you have installed this gem. We offer all these unbelievbale features at a never before price of FREE! FREE! FREE!
 Why are you still waiting? Get your terminals rolling, install this gem and experience the change.
 
+Disclaim: This gem is WIP. We will be adding exciting features like sorting repos by most newcomer issues and active pulse. Until then you should have a look at http://up-for-grabs.net/#/
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,7 +26,7 @@ Or install it yourself as:
 You will need you api access token. [Github people have written about how can you get those magic bits](https://github.com/blog/1509-personal-api-tokens).
 
 Rename `.token.yml.exmaple` to `.token.yml`.
-````
+```
 cp .token.yml.example .token.yml
 ```
 
@@ -32,17 +34,39 @@ Replace `your_github_token` in `.token.yml` with your github token.
 
 ### Look at the stars, Look how they shine for you
 
-Find repos with most stars and open issues, while you hum to [Coldplay in background](https://www.youtube.com/watch?v=yKNxeF4KMsY).
+You can chain various options. For example, following command will return repos with primary language ruby and whose stars are between 1000 and 5000:
 
 ```Ruby
-Contribute::Finder.stars
+Contribute::Finder.new.language("ruby").stars(1000,5000).find
 ```
 
-###  
+You can also use any search string as per [github documentation](https://help.github.com/articles/searching-code/) to find repos.
+
+```Ruby
+Contribute::Finder.new("language:ruby").find
+```
+
+#### Finding repos
+You can filter out repo of your interest using following methods:
+* `forks`
+* `stars`
+* `langauge`
+
+#### Sorting and ordering
+Sort repos by calling `sort_by`. Call `order` with `desc` or `asc` to order your repos in descending and ascending order respectively.
+```Ruby
+# valid option for sorting: created, updated, stars, forks
+Contribute::Finder.new("language:ruby").sort_by('stars').order('asc')find
+```
+Use `Contribute::ExtendedSort` module if you would like sort by name, size, watchers and issues.
+```Ruby
+repos = Contribute::Finder.new("language:ruby").find
+Contribute::ExtendedSort.sort_by!(repos, 'size')
+```
 
 ## Development
 
-Omg Stranger! You very kind for reading this. Contribute needs you! Get your environment loaded with all the gems you will need in your journey ahead:
+Omg Stranger! You are very kind for reading this. Contribute needs you! Get your environment loaded with all the gems you will need in your journey ahead:
 
 ```sh
 # In side contribute folder
@@ -57,12 +81,11 @@ Make changes to code and test it in terminal:
 ```sh
 # Load copy of your gem in your irb
 $ irb -Ilib -rcontribute
-2.3.1 :001 > 
+2.3.1 :001 > Contribute::Finder.new('language:ruby').find
+```
 
-Take at look at [what enemies are up to](https://github.com/NIT-dgp/contribute/issues).
-Slay many bug, you will. Yes, hmmm.
+Take at look at [our issues board](https://github.com/NIT-dgp/contribute/issues).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "contribute"
+require 'bundler/setup'
+require 'contribute'
 
 # 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.
@@ -10,5 +11,5 @@ require "contribute"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/contribute.gemspec

@@ -1,27 +1,34 @@
 # coding: utf-8
+# frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'contribute/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "contribute"
+  spec.name          = 'contribute'
   spec.version       = Contribute::VERSION
-  spec.authors       = ["Aditya Prakash"]
-  spec.email         = ["aditya.prakash132@gmail.com"]
+  spec.authors       = ['Aditya Prakash']
+  spec.email         = ['aditya.prakash132@gmail.com']
 
-  spec.summary       = %q{Contribute finds active repositories on github}
-  spec.description   = %q{It uses github api to find most active repositories for people to contribute.}
-  spec.homepage      = "https://github.com/NIT-dgp/contribute"
-  spec.license       = "MIT"
+  spec.summary       = 'Contribute finds active repositories on github'
+  spec.description   = 'It uses github api to find most active'\
+                        'repositories for people to contribute.'
+  spec.homepage      = 'https://github.com/NIT-dgp/contribute'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  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.require_paths = ['lib']
 
-  spec.add_runtime_dependency "octokit", "~> 4.0"
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'octokit', '~> 4.0'
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.46.0'
+  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
+  spec.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
 end

data/lib/contribute.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 require 'contribute/version'
 require 'octokit'
-require 'pry'
 require 'yaml'
 
 require 'contribute/finder'
-require 'contribute/stars'
+require 'contribute/client'
+require 'contribute/extended_sort'
 
+# Main module of the gem
 module Contribute
 end

data/lib/contribute/client.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Contribute
+  # Class to find repos with stars
+  class Client
+    attr_reader :octokit
+
+    def initialize
+      token_file = YAML.load_file(File.expand_path('../../.token.yml', __dir__))
+      token = token_file['token']
+      @octokit = Octokit::Client.new access_token: token
+    end
+  end
+end

data/lib/contribute/extended_sort.rb

@@ -0,0 +1,16 @@
+module Contribute
+  module ExtendedSort
+    SORT_OPTIONS = %w(name size watchers issues).freeze
+
+  module_function
+
+    def sort_by!(repos, field)
+      raise error_msg unless SORT_OPTIONS.include? field
+      repos.sort! { |a, b| a.send(field) <=> b.send(field) }
+    end
+
+    def error_msg
+      "sort field argument is not valid. Valid inputs: #{SORT_OPTIONS.join(', ')}"
+    end
+  end
+end

data/lib/contribute/finder.rb

@@ -1,17 +1,56 @@
 module Contribute
   class Finder
-    def initialize
-      token_file = YAML::load_file(File.expand_path('../../.token.yml', __dir__))
-      @token = token_file['token']
-      @finder = Octokit::Client.new access_token: token
+    Repo = Struct.new(:full_name, :name, :size, :watchers, :issues)
+
+    SORT_OPTIONS = %w(created updated stars forks).freeze
+    ORDER_OPTIONS = %w(desc asc).freeze
+
+    def initialize(query = '', options = {})
+      @finder_client = Contribute::Client.new.octokit
+      @query = query
+      @options = options
+    end
+
+    def language(name)
+      query << " language:#{name}"
+      self
+    end
+
+    def stars(lo = '*', hi = '*')
+      query << " stars:#{lo}..#{hi}"
+      self
+    end
+
+    def forks(lo = '*', hi = '*')
+      query << " forks:#{lo}..#{hi}"
+      self
     end
 
-    def stars
-      results = finder.search_repositories(' stars:>10000')
-      puts results['items'].map { |r| r['full_name'] }
+    def sort_by(field)
+      raise error_msg('sort', SORT_OPTIONS) unless SORT_OPTIONS.include? field
+      options[:sort] = field
+      self
     end
 
-    private
-    attr_reader :token, :finder
+    def order(type)
+      raise error_msg('order', ORDER_OPTIONS) unless ORDER_OPTIONS.include? type
+      options[:order] = type
+      self
+    end
+
+    def find
+      results = finder_client.search_repositories query, options
+      results['items'].map do |r|
+        Repo.new(r['full_name'], r['name'], r['size'], r['watchers'], r['open_issues'])
+      end
+    end
+
+  private
+
+    attr_reader :finder_client, :query, :options
+
+    def error_msg(type, valid_otions)
+      "'#{type}' field argument is not valid. Valid inputs: #{valid_otions.join(', ')}"
+    end
   end
-end
+end

data/lib/contribute/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Contribute
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contribute
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aditya Prakash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -80,7 +80,61 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: It uses github api to find most active repositories for people to contribute.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+description: It uses github api to find most activerepositories for people to contribute.
 email:
 - aditya.prakash132@gmail.com
 executables: []
@@ -89,6 +143,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".token.yml.example"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -100,8 +156,9 @@ files:
 - bin/setup
 - contribute.gemspec
 - lib/contribute.rb
+- lib/contribute/client.rb
+- lib/contribute/extended_sort.rb
 - lib/contribute/finder.rb
-- lib/contribute/stars.rb
 - lib/contribute/version.rb
 homepage: https://github.com/NIT-dgp/contribute
 licenses:

data/lib/contribute/stars.rb

@@ -1,5 +0,0 @@
-module Contribute
-  class Stars
-
-  end
-end