github-api-v3 0.0.1.placeholder → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 465a338c598c611d8cd86304a5787b4a85b1d5ab
-  data.tar.gz: e5e5e85d95629a297d9a4b853020d659e9395727
+  metadata.gz: 39ab5a347837f79c27c8e5623dfb1297ad429ddd
+  data.tar.gz: d4a479ad761d0f9deb795f30bcf23c068ad5b6c2
 SHA512:
-  metadata.gz: a0a9445336045e30115afa84146b10187a999414efdd8d0a5b514566a302201f85bc8a2e9d61f8dfd689dd77de506846bdbd9dece4b317cd0a798ea125cf08c1
-  data.tar.gz: 6d88430f1ebe68bb98ad193b82ea3f00fd347c9eb74baf0094e06ba9f9be59832d145db60d1a0879da58bb241271b2634ab49c622904cc628d4e8ab60b5caf0e
+  metadata.gz: 513c8040828a756849db0066f790ccf35732ccb6839ae14057c1cb3498a509282233a38a5028c204dc2b46f94fcd516052faedc0e59cb0942eb882acd4f7a152
+  data.tar.gz: d6beaa9cec0e17ab082e544a6c3838729c1c2aa4dfb8e2c6e6d32a788135ccb267ec655b978a5d79aee96d7176fddb926433d50c46f491c07596ef8b699e833b

data/.rspec

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

data/README.md

@@ -1,24 +1,89 @@
 # GitHub API v3 Wrapper
 
-TODO: Write a gem description
+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
 
-Add this line to your application's Gemfile:
+As of right now, the library has not reached a version which I consider worth pushing to RubyGems.org. Feel free to clone the repository and build the gem and install it if you wish:
 
-    gem 'github-api-v3'
+```bash
+$ git clone https://github.com/caseyscarborough/github && cd github
+$ gem build github-api-v3.gemspec
+$ gem install github-api-v3-0.0.1.gem
+```
 
-And then execute:
+## Usage
 
-    $ bundle
+Add the following line to your gemfile:
 
-Or install it yourself as:
+```ruby
+gem 'github-api-v3'
+```
 
-    $ gem install github-api-v3
+or install it manually:
 
-## Usage
+```bash
+$ gem install github-api-v3
+```
+
+Then you can proceed to use it in the following manner:
+
+#### 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.
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/github-api-v3.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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      = ''
+  spec.homepage      = 'https://github.com/caseyscarborough/github'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -20,4 +20,7 @@ Gem::Specification.new do |spec|
 
   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.rb

@@ -1,4 +1,32 @@
+require 'httparty'
 require 'github/version'
+require 'github/error'
+require 'github/configuration'
+require 'github/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/lib/github/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/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/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/version.rb

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

data/spec/github/client_spec.rb

@@ -0,0 +1,53 @@
+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
+
+  describe 'exceptions' do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'github'
+
+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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github-api-v3
 version: !ruby/object:Gem::Version
-  version: 0.0.1.placeholder
+  version: 0.0.1
 platform: ruby
 authors:
 - Casey Scarborough
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !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
@@ -46,14 +74,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - github-api-v3.gemspec
 - lib/github.rb
+- lib/github/client.rb
+- lib/github/configuration.rb
+- lib/github/error.rb
 - lib/github/version.rb
-homepage: ''
+- spec/github/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/caseyscarborough/github
 licenses:
 - MIT
 metadata: {}
@@ -68,13 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      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: []
+test_files:
+- spec/github/client_spec.rb
+- spec/spec_helper.rb