pr_status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 507a82a813a008b5862fd9e7ba2d48aea1c8c28b
+  data.tar.gz: 2b92fd361e794466b50a3d19533af3958efc16c9
+SHA512:
+  metadata.gz: aac8a7a953f376acac9f11343baf4d9a966435f7d033199ee671cbce3dc6c927f9124b4d93d1cbbe37278c340fb5211dcbe971986693eb9edcef5a9f84320a84
+  data.tar.gz: 2654d631c2bad6b77f333095ff8c631570ab4b1dab3da8d418e8ba6b043859703a7c30971dc82f48492669cf69e3d36a3d86259874bcb4212ca79d10f27a933f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1
+  - 2.2
+  - 2.3
+
+before_install: gem install bundler -v 1.11.2

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 zsyed91@gmail.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,21 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pr_status.gemspec
+gemspec
+
+gem 'rake', '~> 10.1'
+
+group :development, :test do
+  gem 'pry'
+end
+
+group :development do
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-mocks'
+  gem 'factory_girl'
+  gem 'faker'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zshawn Syed
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zshawn Syed
+
+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,62 @@
+# PrStatus
+
+Simple ruby class to get the count of pull requests open. Internally uses the `Octokit` wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pr_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pr_status
+
+## Usage
+
+### Authentication
+Pass in `access_token` or `login` and `password`.
+
+```ruby
+  # Access token (generated from github.com)
+  client = PrStatus::Auth.new(access_token: '<40 char access token>').authenticate
+
+  # Username/Password
+  client = PrStatus::Auth.new(login: 'github_username', password: 'password').authenticate
+```
+
+### Getting pull request count
+Returns the count of open and closed pull requests that have been opened by the authenticated user.
+Defaults to searching from the first of the current month until today.
+```ruby
+  client.pull_requests
+```
+
+#### Filters
+You can filter the range that the client will search for pull requests by `created_at` date.
+
+```ruby
+  client.pull_requests(range: 'monthly')
+```
+
+## 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/zsyed91/pr_status. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,3 @@
+require 'pr_status/version'
+require 'pr_status/auth'
+require 'pr_status/client'

data/lib/pr_status/auth.rb

@@ -0,0 +1,54 @@
+module PrStatus
+  # Class to create the client wrapper around octokit
+  class Auth
+    # Credentials hash follows the octokit Client.new params:
+    #  For username/password:
+    #     login: username, password: password
+    #
+    #  For api_token (recommended) since username/password is not even sent
+    #     auth_token: <github auth token 40 chars>
+    def initialize(credentials)
+      unless credentials.is_a?(Hash)
+        fail ArgumentError, 'Need to pass in credentials hash'
+      end
+      @credentials = credentials
+
+      validate_credentials if username? || password?
+      if credentials[:access_token]
+        validate_access_token(credentials[:access_token])
+      end
+ 
+    end
+
+    def authenticate
+      PrStatus::Client.new(@credentials)
+    end
+
+    private
+
+    def validate_access_token(token)
+      fail ArgumentError, 'Invalid Auth Token' unless token.length == 40
+    end
+
+    def validate_credentials
+      fail ArgumentError, 'Password missing' if !password?
+      fail ArgumentError, 'Username (:login) missing' if !username?
+    end
+
+    def username?
+      @credentials[:login] && !@credentials[:login].empty?
+    end
+
+    def password?
+      @credentials[:password] && !@credentials[:password].empty?
+    end
+
+    def credentials
+      if @credentials[:auth_token]
+        { auth_token: @credentials[:auth_token] }
+      else
+        { login: @credentials[:login], password: @credentials[:password] }
+      end
+    end
+  end
+end

data/lib/pr_status/client.rb

@@ -0,0 +1,47 @@
+require 'octokit'
+module PrStatus
+  # Client class for Octokit
+  #  Holds an internal reference to Octokit::Client
+  #  and other related methods for interacting with octokit's api wrapper
+  class Client
+    attr_accessor :user
+    def initialize(credentials)
+      @octokit = Octokit::Client.new(credentials)
+      # Cache the user info so we don't have to make another request
+      @user = @octokit.user
+    end
+
+    def pull_requests(filters = {})
+      filters = default_filters.merge(filters)
+      @octokit.search_issues(build_query(filters))[:total_count]
+    end
+
+    def repos
+      @repos ||= @octokit.repos
+    end
+
+    private
+
+    def build_query(filters)
+      ["author:#{@user[:login]}",
+       'type:pr',
+       "created:>=#{filter_date(filters)}"].join(' ')
+    end
+
+    def filter_date(filters)
+      time = Time.now
+      case filters[:range]
+      when 'monthly'
+        if time.month < 10
+          "#{time.year}-0#{time.month}-01"
+        else
+          "#{time.year}-#{time.month}-01"
+        end
+      end
+    end
+
+    def default_filters
+      { range: 'monthly' }
+    end
+  end
+end

data/lib/pr_status/version.rb

@@ -0,0 +1,3 @@
+module PrStatus
+  VERSION = '0.1.0'
+end

data/pr_status.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pr_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pr_status'
+  spec.version       = PrStatus::VERSION
+  spec.authors       = ['Zshawn Syed']
+  spec.email         = ['zsyed91@gmail.com']
+
+  spec.summary       = 'Get the count of pull requests opened'
+  spec.description   = 'Get the count of pull requests opened from the first of the month'
+  spec.homepage      = 'https://github.com/zsyed91/pr_status'
+  spec.license       = 'MIT'
+
+  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_runtime_dependency('octokit', '~> 4.0')
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: pr_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zshawn Syed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Get the count of pull requests opened from the first of the month
+email:
+- zsyed91@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pr_status.rb
+- lib/pr_status/auth.rb
+- lib/pr_status/client.rb
+- lib/pr_status/version.rb
+- pr_status.gemspec
+homepage: https://github.com/zsyed91/pr_status
+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.5
+signing_key: 
+specification_version: 4
+summary: Get the count of pull requests opened
+test_files: []
+has_rdoc: