github_api_ruby_lib 0.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eb14625a9ba9dd422b87ff0097516c326b4941d
-  data.tar.gz: 6a384708a7dadea847f367fc36cbb2a0d595ef2d
+  metadata.gz: 68eb1220af63cf547ae8f0ecd9ff2ff439e30760
+  data.tar.gz: faea69093369a5861524363e0b41c49e6b380541
 SHA512:
-  metadata.gz: 8cd1d1589464fd28e64cf21f7baf663c5f364b24c518c904e98141eba390702a50e16fd3d027ff14e0903bfc0038cd3e23c9cb89190d6fd3714bddbd1375f5ca
-  data.tar.gz: 323c2a503592119f4e50fd5b61afa9d0792d37307667b79228c0746c1bf1ac06ac3b0e2d051d135b2ce6a60fc3f8877c194fda0b6bd09f0ceaee9c7e83e320c4
+  metadata.gz: 088d54b65eb9333dc0eb651d14134316bbd7b72ca9dfa63314d8b3d61da50f5044c7c15d8a0ce31f2fe977395c84f98f968f8e7b557b254df88e6928cb02a211
+  data.tar.gz: d55602d8a8176e1d5e4907115a0a782f97c0ecf6ed8da228039e6c0b655261d90d7ab511564800706f86ee2ece8bd93f55af3c99b3c4653abb0bca203920f181

data/lib/github_api_ruby_lib/http/api_options.rb

@@ -0,0 +1,26 @@
+
+class Api_options
+
+  #All repository related features
+  module REPO
+    #Get languages (value=1)
+    LANGUAGES=1
+    #Get contributors (value=2)
+    CONTRIBUTORS=2
+    #Get README (value=3)
+    README=3
+    #Get all repositories (value=7)
+    ALL_REPOS=7
+  end
+
+  #All user related features
+  module USER
+    #Get email of given user (value=4)
+    EMAIL=4
+    #Get search results of user (value=5)
+    SEARCH=5
+    #Get all followers of user (value=6)
+    FOLLOWERS=6
+  end
+
+end

data/lib/github_api_ruby_lib/http/http_handler.rb

@@ -0,0 +1,39 @@
+module HttpHandler
+
+
+  def self.create_http(uri)
+    @@http=Net::HTTP.new(uri.host,uri.port)
+    @@http.use_ssl = true
+  end
+
+
+
+  #Method gets response from GET request, checks for validiation, and returns json
+  #====Attributes
+  #
+  #- +https+ - HTTP object sending the GET request. Must be previously initialized
+  #- +uri+ - Uri object holding converted API url, used for sending GET request
+  def self.get_response(https,uri)  # :yields: JSON
+
+    result=https.get(uri)
+    if result.code =="200"
+      return JSON.parse(result.body)
+    else
+      raise "HTTP failed with code: #{result.code}"
+    end
+  end
+
+
+  #Creates a new HTTP object with the given uri's host and port
+  #====Attributes
+  #- +uri+ - Uri object containing api link
+  #
+  def self.initiate_http(uri) # :yields: HTTP
+    http=Net::HTTP.new(uri.host,uri.port)
+    http.use_ssl = true
+    return http
+  end
+
+
+
+end

data/lib/github_api_ruby_lib/http/repo_http_handler.rb

@@ -0,0 +1,104 @@
+
+require 'net/http'
+require 'open-uri'
+require_relative 'uri_builder'
+require 'json'
+require 'benchmark'
+require_relative 'api_options'
+require_relative 'http_handler'
+
+class RepoHttpHandler
+  include HttpHandler
+  @@app_token=nil
+  def initialize
+    @@responseStatus=false
+    @@uri_builder=UriBuilder.new
+
+  end
+
+
+  def self.set_auth_token (token)
+    @@app_token=token
+  end
+
+    #Retrieves all the major languages used in a repository
+    #====Attributes
+    #
+    #- +username+ -> username of github repo
+    #- +repo_name+ -> name of repository to get languages
+    def get_languages_of_a_repository(username, repo_name) # :yields: JSON
+      uri=URI.parse(@@uri_builder.get_repo_content(Api_options::REPO::LANGUAGES,username,repo_name))
+      http=HttpHandler.initiate_http(uri)
+
+      begin
+        response=HttpHandler.get_response(http,uri)
+      rescue ArgumentError
+        puts "Request failed with code: #{response.code}"
+      else
+        @@responseStatus=true
+        return response
+      end
+    end
+
+
+    def get_response_status
+      @@responseStatus
+    end
+
+    #Get a list of repositories for the given user
+    #====Attributes
+    #- +username+ -> username of the account
+    def get_user_repos(username) # :yields: JSON
+      uri=URI.parse(@@uri_builder.user_repos_url(username,@@app_token))
+      http=HttpHandler.initiate_http(uri)
+      begin
+        response=HttpHandler.get_response(http,uri)
+      rescue ArgumentError
+        puts "Request failed with code: #{response.code}"
+      else
+        @@responseStatus=true
+        return response
+      end
+    end
+
+
+    #Get all contributors of a given repository
+    #====Attributes
+    #- +username+ -> username of the account
+    #- +repo_name+ -> name of repository
+    def get_contributors_of_a_repository(username,repo_name) # :yields: JSON
+      uri=URI.parse(@@uri_builder.get_repo_content(Api_options::REPO::CONTRIBUTORS,username,repo_name))
+      http= HttpHandler.initiate_http(uri)
+      begin
+        response=HttpHandler.get_response(http,uri)
+      rescue ArgumentError
+        puts "Request failed with code: #{response.code}"
+      else
+        @@responseStatus=true
+        return response
+      end
+    end
+
+
+    #Get README of given repository
+    #==== Attributes
+    #- +username+ -> username of the account
+    #- +repo_name+ -> name of repository
+    def get_readme_of_a_repository(username,repo_name) # :yields: JSON
+      uri=URI.parse(@@uri_builder.get_repo_content(Api_options::REPO::README,username,repo_name))
+      http=HttpHandler.initiate_http(uri)
+      begin
+        response=HttpHandler.get_response(http,uri)
+      rescue ArgumentError
+        puts "Request failed with code: #{response.code}"
+      else
+        @@responseStatus=true
+        return response
+      end
+    end
+
+end
+
+
+
+

data/lib/github_api_ruby_lib/http/uri_builder.rb

@@ -0,0 +1,101 @@
+require_relative 'api_options'
+
+class UriBuilder
+
+  attr_accessor :base_url
+  attr_writer :base_url
+
+
+  #base api string required for all calls
+  BASE_URL="https://api.github.com/"
+
+  #string add-on to find user related information
+  USERS="users/"
+
+  #string add-on to search for relevant information
+  SEARCH="search/"
+
+  #string add-on to find repo related information
+  REPOS="repos/"
+
+  #holds app token needed for authentication requests
+  @@token
+
+
+  #sets the token to make authenticated requests
+  #==== Attributes
+  #- +token+ -> [String] app token needed to make authenticated requests
+  def self.set_personal_access_token(token)
+    @@token=token
+  end
+
+
+  #gets personal access token
+  def personal_access_token # :yields: String
+    @@token
+  end
+
+
+
+  def initialize
+    @@token=''
+  end
+
+
+  #Base API string to get all repos of user
+  #====Attributes
+  #- +username+ -> username of account
+  def user_repos_url(username,token) # :yields:String
+    BASE_URL + USERS + "#{username}/" + "repos?access_token=#{token}"
+  end
+
+
+
+  #Build API string for repository related queries
+  #====Attributes
+  #- +type+ -> Options to build API string
+  #- +username+ -> username of account to access repo content
+  #- +repo_name+ -> name of repository
+  def get_repo_content(type, username, repo_name) # :yields: String
+    case type
+
+      when Api_options::REPO::LANGUAGES
+        "#{BASE_URL}" +  "#{REPOS}" + "#{username}/" + "#{repo_name}/languages"
+      when Api_options::REPO::CONTRIBUTORS
+        BASE_URL + REPOS + "#{username}" + "/" + "#{repo_name}" + "/" + "contributors"
+      when Api_options::REPO::README
+        BASE_URL + REPOS + "#{username}" + "/" + "#{repo_name}" + "/" + "readme"
+    end
+  end
+
+
+  #Build API string for user related queries
+  #====Attributes
+  #- +type+ -> Options to build API string
+  #- +params+ -> Additional parameters to narrow search criteria
+  def get_user_contents(type, params) # :yields: String
+    case type
+      when Api_options::USER::EMAIL
+        unless personal_access_token.nil?
+          "#{BASE_URL}user/emails?access_token=#{params[:app_token]}"
+        else
+          raise "Authentication required"
+        end
+      when Api_options::USER::SEARCH
+        unless params[:number_of_repos] == nil
+          return BASE_URL + SEARCH + USERS + "q=#{params[:by_name]}+repos=#{params[:number_of_repos]}"
+        else
+          return BASE_URL + SEARCH + USERS + "q=#{params[:by_name]}"
+        end
+      when Api_options::USER::FOLLOWERS
+         BASE_URL + USERS + "#{params[:username]}/followers?access_token=#{params[:token]}"
+    end
+  end
+
+
+
+
+
+
+end
+

data/lib/github_api_ruby_lib/http/user_http_handler.rb

@@ -0,0 +1,97 @@
+require_relative 'http_handler'
+require 'net/http'
+require 'open-uri'
+require_relative 'uri_builder'
+require 'json'
+
+class UserHttpHandler
+  include HttpHandler
+
+  @@app_token=nil
+  @@http=nil
+  def initialize
+    @response_status=false
+    @uri_builder=UriBuilder.new
+  end
+
+
+  #Set the authentication token
+  #====Attribute
+  #- +token+ -> token generated that is needed to make authentication calls
+  def self.set_auth_token (token)
+    @@app_token=token
+  end
+
+  def self.get_auth_token
+    @@app_token
+  end
+  #get all the followers of the given user
+  #==== Attributes
+  #- +params+ -> optional parameters for getting followers
+  #
+  def get_user_followers(params) # :yields: JSON
+    uri=URI.parse(@uri_builder.get_user_contents(Api_options::USER::FOLLOWERS,username:params[:username], token:@@app_token))
+    http=HttpHandler.initiate_http(uri)
+    begin
+      if @@app_token == nil
+        raise "Authentication not provided"
+      end
+      response=HttpHandler.get_response(http,uri)
+    rescue ArgumentError
+      puts "Request failed with code: #{response.code}"
+    else
+      @response_status=true
+      return response
+    end
+  end
+
+
+  #Search and retrieve user information based on search parameters
+  #==== Attributes
+  #- +params+ -> optional filters for getting users
+  #
+  def search_for_user(params) # :yields: JSON
+    uri=URI.parse(@uri_builder.get_user_contents(Api_options::USER::SEARCH, params))
+    http=HttpHandler.initiate_http(uri)
+    begin
+      response=HttpHandler.get_response(http,uri)
+    rescue ArgumentError
+      puts "Request failed with code: #{response.code}"
+    else
+      @response_status=true
+      return response
+    end
+  end
+
+
+
+  #Search for email address of user
+  #==== Attributes
+  #- +username+ -> username id to get email
+  def search_for_user_email(username) # :yields: JSON
+    begin
+    if @@app_token == nil
+      raise "Authentication not provided"
+    end
+    uri=URI.parse(@uri_builder.get_user_contents(Api_options::USER::EMAIL,username:username, app_token:@@app_token))
+    @uri_builder=nil
+
+    HttpHandler.create_http uri
+
+    response=HttpHandler.get_response(@@http,uri)
+      @response_status=true
+      return response
+
+  end
+
+
+
+
+
+  end
+
+  #returns the response status that is true if request was successful
+  def get_response_status
+    @response_status
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_api_ruby_lib
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - jacob
@@ -45,22 +45,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
-- github_api_ruby_lib.gemspec
-- lib/github_api_ruby_lib.rb
-- lib/github_api_ruby_lib/version.rb
+- lib/github_api_ruby_lib/http/api_options.rb
+- lib/github_api_ruby_lib/http/http_handler.rb
+- lib/github_api_ruby_lib/http/repo_http_handler.rb
+- lib/github_api_ruby_lib/http/uri_builder.rb
+- lib/github_api_ruby_lib/http/user_http_handler.rb
 homepage: https://github.com/jabrah29/Github_Api_Ruby_Library
 licenses:
 - MIT
-metadata:
-  allowed_push_host: http://mygemserver.com
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -77,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Small Ruby library for using the Github api.

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-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.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at jabrah29@uic.edu. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in github_api_ruby_lib.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 jacob
-
-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

@@ -1,43 +0,0 @@
-# GithubApiRubyLib
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/github_api_ruby_lib`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'github_api_ruby_lib'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install github_api_ruby_lib
-
-## Usage
-
-TODO: Write usage instructions here
-
-## 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/[USERNAME]/github_api_ruby_lib. 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).
-
-## Code of Conduct
-
-Everyone interacting in the GithubApiRubyLib project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/github_api_ruby_lib/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,2 +0,0 @@
-require "bundler/gem_tasks"
-task :default => :spec

data/bin/console

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

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/github_api_ruby_lib.gemspec

@@ -1,35 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "github_api_ruby_lib/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "github_api_ruby_lib"
-  spec.version       = GithubApiRubyLib::VERSION
-  spec.authors       = ["jacob"]
-  spec.email         = ["jabrah29@uic.edu"]
-
-  spec.summary       = %q{Small Ruby library for using the Github api.}
-  spec.description   = %q{Ruby library used for basic GET requests}
-  spec.homepage      = "https://github.com/jabrah29/Github_Api_Ruby_Library"
-  spec.license       = "MIT"
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = "http://mygemserver.com"
-  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 do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-end

data/lib/github_api_ruby_lib.rb

@@ -1,5 +0,0 @@
-require "github_api_ruby_lib/version"
-
-module GithubApiRubyLib
-  # Your code goes here...
-end

data/lib/github_api_ruby_lib/version.rb

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