github_api_v3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1484792ee09d3b78a77bbb52789a41c0513c41e
+  data.tar.gz: f4975ee821dbf872a3bd4cc0f6f63dc6190d9eee
+SHA512:
+  metadata.gz: 91a3f5ac2a6debb3d6dcd7b14098378c55912c9098d5648b899a4ab632ce61a44f701bfa8eb2f563380334265810d71e7cd2d9cc323762a446d6907b9f3a54ae
+  data.tar.gz: a4bfafbe187cbbc114156d23b7ee2a4162abb6d1c01bce6595664dece25a4b4621641a476ea6c6cdbeeb843d4a29e31667145c53aea428e5e5c54ec5abfcf30d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Casey Scarborough
+
+MIT License
+
+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,81 @@
+# GitHub API v3 Wrapper
+
+This is a simple wrapper for GitHub's v3 API. It is in the EARLY stages of development. Knowing a little about [GitHub's API](http://developer.github.com/) will aid in its use.
+
+## Installation
+
+```bash
+$ gem install github_api_v3
+```
+
+## Usage
+
+```ruby
+require 'github_api_v3'
+# => true
+```
+
+#### User
+
+Returns a Hash containing information about a user.
+
+```ruby
+user = GitHub.user('caseyscarborough')
+user.login     # => "caseyscarborough"
+user.name      # => "Casey Scarborough"
+user.html_url  # => "https://github.com/caseyscarborough"
+user.following # => 23
+# etc...
+```
+You can find the available attributes [here](http://developer.github.com/v3/users/#get-a-single-user).
+
+#### Events
+
+Returns an array of events for a particular user.
+
+```ruby
+events = GitHub.events('caseyscarborough')
+events.each { |e| puts e.type }
+```
+
+#### Followers
+
+Returns an array of followers for a user.
+
+```ruby
+followers = GitHub.followers('caseyscarborough')
+followers.each { |f| puts f.login }
+```
+
+#### Repositories
+
+Returns an array of repositories that belong to a user.
+
+```ruby
+repos = GitHub.repos('caseyscarborough')
+repos.each { |r| puts r.name }
+```
+
+### Authenticated Requests
+
+Some methods, such as retrieving private repos or emails, require authentication. To create one of these requests, you'll need to pass in your login and access token. You can create a personal access token on your [account page](https://github.com/settings/applications).
+
+```ruby
+client = GitHub::Client.new(login: 'username', access_token: 'abcdefghijklmnopqrstuvwxyz12345')
+client.emails # => ["email@example.com", "email2@example.com"]
+```
+
+More functionality to come.
+
+## To Do
+
+The better question is... What's not to do? Any functionality of the API listed at [developer.github.com](http://developer.github.com/) that isn't currently in effect.
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/github_api_v3.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_api_v3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github_api_v3'
+  spec.version       = GitHub::VERSION
+  spec.authors       = ['Casey Scarborough']
+  spec.email         = ['caseyscarborough@gmail.com']
+  spec.description   = "A wrapper for GitHub's API v3."
+  spec.summary       = "This gem is a wrapper that allows simple interaction with GitHub's API v3."
+  spec.homepage      = 'https://github.com/caseyscarborough/github'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  
+  spec.add_dependency 'httparty', '0.11.0'
+end

data/lib/github_api_v3/client.rb

@@ -0,0 +1,67 @@
+module GitHub
+  class Client
+
+    include HTTParty
+    base_uri Configuration::DEFAULT_ENDPOINT
+
+    attr_reader :login, :access_token
+
+    def initialize(login=nil, access_token=nil)
+      @login = login
+      @access_token = access_token
+    end
+
+    def user(username)
+      get "/users/#{username}"
+    end
+
+    def users
+      get "/users"
+    end
+
+    # Get emails for authenticated user
+    def emails
+      get "/user/emails", auth_params
+    end
+
+    def followers(username)
+      get "/users/#{username}/followers"
+    end
+
+    def following(username)
+      get "/users/#{username}/following"
+    end
+
+    def events(username)
+      get "/users/#{username}/events"
+    end
+
+    def repos(username)
+      get "/users/#{username}/repos"
+    end
+
+    private
+
+      def get(url, params={})
+        response = self.class.get url, query: params
+        handle_response(response)
+        response.parsed_response
+      end
+
+      def auth_params
+        @login.nil? ? {} : { login: @login, access_token: @access_token }
+      end
+
+      def handle_response(response)
+        case response.code
+        when 401 then raise Unauthorized
+        when 403 then raise RateLimitExceeded
+        when 404 then raise NotFound
+        when 400..500 then raise ClientError
+        when 500..600 then raise ServerError, response.code
+        else
+          response
+        end
+      end
+  end
+end

data/lib/github_api_v3/configuration.rb

@@ -0,0 +1,15 @@
+module GitHub
+  module Configuration
+
+    DEFAULT_ENDPOINT = "https://api.github.com".freeze
+
+  end
+end
+
+class ::Hash
+  def method_missing(name)
+    return self[name] if key? name
+    self.each { |k,v| return v if k.to_s.to_sym == name }
+    super.method_missing name
+  end
+end

data/lib/github_api_v3/error.rb

@@ -0,0 +1,11 @@
+module GitHub
+  
+  class GitHubError < StandardError; end
+  class NotFound < GitHubError; end
+  class Unauthorized < GitHubError; end
+  class Unavailable < GitHubError; end
+  class RateLimitExceeded < GitHubError; end
+  class ServerError < GitHubError; end
+  class ClientError < GitHubError; end
+  
+end

data/lib/github_api_v3/version.rb

@@ -0,0 +1,3 @@
+module GitHub
+  VERSION = '0.0.1'
+end

data/lib/github_api_v3.rb

@@ -0,0 +1,32 @@
+require 'httparty'
+require 'github_api_v3/version'
+require 'github_api_v3/error'
+require 'github_api_v3/configuration'
+require 'github_api_v3/client'
+
+module GitHub
+
+  class << self
+    
+    def user(username)
+      Client.new.user(username)
+    end
+
+    def users
+      Client.new.users
+    end
+
+    def followers(username=nil)
+      Client.new.followers(username)
+    end
+
+    def events(username)
+      Client.new.events(username)
+    end
+
+    def repos(username)
+      Client.new.repos(username)
+    end
+
+  end
+end

data/spec/github_api_v3/client_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe GitHub::Client do
+
+  let(:user) { GitHub.user('caseyscarborough') }
+
+  subject { GitHub }
+
+  it { should respond_to :user }
+  it { should respond_to :events }
+  it { should respond_to :followers }
+  it { should respond_to :repos }
+
+  describe 'default attributes' do
+    it 'must include httparty' do
+      GitHub::Client.should include(HTTParty)
+    end
+
+    it 'must have base URI set to GitHub API endpoint' do
+      GitHub::Client.base_uri.should eq('https://api.github.com')
+    end
+  end
+
+  describe 'get user data' do
+    it 'should parse the API response from JSON to Hash' do
+      user.should be_instance_of Hash
+    end
+
+    it 'should get the correct user info' do
+      user['login'].should eq('caseyscarborough')
+    end
+  end
+
+  describe 'event data' do
+    it 'should return an array of events' do
+      GitHub.events(user['login']).should be_instance_of Array
+    end
+  end
+
+  describe 'followers' do
+    it 'should return an array of users' do
+      GitHub.followers(user['login']).should be_instance_of Array
+    end
+  end
+
+  describe 'repositories' do
+    it 'should return an array of repositories' do
+      GitHub.repos(user['login']).should be_instance_of Array
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'github_api_v3'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: github_api_v3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Casey Scarborough
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: A wrapper for GitHub's API v3.
+email:
+- caseyscarborough@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- github_api_v3.gemspec
+- lib/github_api_v3.rb
+- lib/github_api_v3/client.rb
+- lib/github_api_v3/configuration.rb
+- lib/github_api_v3/error.rb
+- lib/github_api_v3/version.rb
+- spec/github_api_v3/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/caseyscarborough/github
+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.0.5
+signing_key: 
+specification_version: 4
+summary: This gem is a wrapper that allows simple interaction with GitHub's API v3.
+test_files:
+- spec/github_api_v3/client_spec.rb
+- spec/spec_helper.rb