github_api_v3 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9169cd9f387218e0671168e9eb4a2f1d1f18e509
-  data.tar.gz: 3d0068723c6ced874e5ffb071a7484268c1b0fba
+  metadata.gz: 3ae00133104efbad81d712e9a61b52de37acce7e
+  data.tar.gz: 07808ae90ba4cd395dc489fc6abf803ad69288bd
 SHA512:
-  metadata.gz: 167c034acff48603440160992bafe2bb2dfbff57c8aafc54c716167bad2a31c6dc8ea9d5e80a098a981fec3ceff0b2e47d21dbdc6238006122f873c6457d0e3a
-  data.tar.gz: 873d6d203131801d3c45b646031cc2373997c5ac1bb069579be2af3d3e2c146493b0dbce75b537ea1f6722df8c270e78f40db5f0c79f9d6781381d3322455626
+  metadata.gz: 2b27ea74d7310ccbae210186b9cd811aa3aad2eb2144a2677384f573f424a5327dac504acfe1430acf6ae5de80700794f3322d9fa5fa76e6d091bf4ec37d750c
+  data.tar.gz: 9c118dcad30804554236432f8a80a9e6349de7aac7d89ee2db12384642c6068ba436b402f1080096ef7a1fe3cae91f9dbd06975778215bf9f4c5d5d8897ed424

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+/versions
+.DS_Store
+/spec/config.yml

data/README.md

@@ -69,6 +69,9 @@ Some methods, such as retrieving private repos or emails, require authentication
 ```ruby
 client = GitHub::Client.new(login: 'username', access_token: 'abcdefghijklmnopqrstuvwxyz12345')
 client.emails # => ["email@example.com", "email2@example.com"]
+client.repos  # => #<Array:0x007fb8aa0d1a00>
+client.follow('matz') # => true
+client.user   # => #<Hash:0x007fb8a9109d70>
 ```
 
 More functionality to come.
@@ -77,7 +80,6 @@ More functionality to come.
 
 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

data/github_api_v3.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock', '1.11.0'
+  spec.add_development_dependency 'vcr'
   
   spec.add_dependency 'httparty', '0.11.0'
 end

data/lib/github_api_v3.rb

@@ -1,7 +1,7 @@
 require 'httparty'
 require 'github_api_v3/version'
 require 'github_api_v3/error'
-require 'github_api_v3/configuration'
+require 'github_api_v3/default'
 require 'github_api_v3/client'
 
 module GitHub

data/lib/github_api_v3/client.rb

@@ -1,87 +1,22 @@
+require 'json'
+require 'github_api_v3/client/users'
+require 'github_api_v3/client/repos'
+
 module GitHub
   class Client
 
     include HTTParty
-    base_uri Configuration::DEFAULT_ENDPOINT
+    base_uri Default::API_ENDPOINT
+
+    include GitHub::Client::Users
+    include GitHub::Client::Repos
 
     attr_reader :login, :access_token
 
     def initialize(options={})
       @login = options[:login]
-      @access_token = options[:access_token]
-    end
-
-    # Users
-
-    def user(username=nil)
-      if username
-        get "/users/#{username}"
-      else
-        get '/user', auth_params
-      end
-    end
-
-    def users
-      get '/users'
-    end
-
-    # Get emails for authenticated user
-    def emails
-      get '/user/emails', auth_params
-    end
-
-    def follow(username)
-      put "/user/following/#{username}", auth_params
-    end
-
-    def follows?(username, target_username)
-      response = self.class.get "/users/#{username}/following/#{target_username}"
-      response.code == 204
-    end
-
-    def followers(username=nil)
-      if username
-        get "/users/#{username}/followers"
-      else
-        get '/user/followers', auth_params
-      end
-    end
-
-    def following(username)
-      get "/users/#{username}/following"
-    end
-
-    def following?(username)
-      response = self.class.get "/user/following/#{username}", query: auth_params
-      response.code == 204
-    end
-
-    def unfollow(username)
-      delete "/user/following/#{username}", auth_params
-    end
-
-    def keys(username=nil)
-      if username
-        get "/users/#{username}/keys"
-      else
-        get '/user/keys', auth_params
-      end
-    end
-
-    def key(id)
-      get "/user/keys/#{id}", auth_params
-    end
-
-    def delete_key(id)
-      delete "/user/keys/#{id}", auth_params
-    end
-
-    def events(username)
-      get "/users/#{username}/events"
-    end
-
-    def repos(username)
-      get "/users/#{username}/repos"
+      @access_token = options[:access_token] if options[:access_token]
+      @password = options[:password] if options[:password]
     end
 
     private
@@ -92,21 +27,26 @@ module GitHub
         response.parsed_response
       end
 
-      def put(url, params={})
+      def put(url, params={}, boolean=false)
         response = self.class.put url, query: params
         handle_response(response)
-        response.parsed_response
+        boolean ? response.code == 204 : response.parsed_response
       end
 
-      def post(url, params={})
-        response = self.class.post url, query: params
-        response.code
+      def post(url, params={}, body={}, boolean=false)
+        response = self.class.post url, query: params, body: body.to_json
+        handle_response(response)
+        boolean ? response.code == 204 : response.parsed_response
       end
 
-      def delete(url, params={})
+      def delete(url, params={}, boolean=false)
         response = self.class.delete url, query: params
         handle_response(response)
-        response.parsed_response
+        boolean ? response.code == 204 : response.parsed_response
+      end
+
+      def basic_params
+        @password.nil? ? {} : { login: @login, password: @password }
       end
 
       def auth_params

data/lib/github_api_v3/client/repos.rb

@@ -0,0 +1,160 @@
+module GitHub
+  class Client
+
+    module Repos
+      
+      # List all repositories
+      #
+      # Get a list of all repositories.
+      #
+      # @return [Array]
+      # @see http://developer.github.com/v3/repos/#list-all-public-repositories
+      def all_repos
+        get '/repositories'
+      end
+
+      # Get one repository.
+      #
+      # @param owner [String] Username of repository owner.
+      # @param repo [String] Name of repository.
+      # @return [Hash] Repository information.
+      # @see http://developer.github.com/v3/repos/#get
+      # @example
+      #   GitHub.repo('caseyscarborough','github')
+      def repo(owner, repo)
+        get "/repos/#{owner}/#{repo}"
+      end
+
+      # Get all repositories for a user.
+      #
+      # If authenticated, returns all repos for authenticated user.
+      #
+      # @param username [String] Username for repos owner.
+      # @return [Array] List of repositories.
+      # @see http://developer.github.com/v3/repos/#list-user-repositories
+      # @example
+      #   GitHub.repos('caseyscarborough')
+      # @example
+      #   client.repos
+      def repos(username=nil)
+        if username
+          get "/users/#{username}/repos"
+        else
+          get '/user/repos', auth_params
+        end
+      end
+
+      # Create a repository.
+      #
+      # Requires authentication.
+      #
+      # @param name [String] Repository name.
+      # @param options [Hash] Repository information.
+      # @option options [String] :description Repository description.
+      # @option options [String] :homepage Repository homepage.
+      # @option options [Boolean] :private
+      # @option options [Boolean] :has_issues
+      # @option options [Boolean] :has_wiki
+      # @option options [Boolean] :has_downloads
+      # @option options [Integer] :team_id ID of team
+      # @option options [Boolean] :auto_init Create README.md automatically.
+      # @option options [String] :gitignore_template Desired .gitignore template to apply.
+      # @return [Hash] Repository information.
+      # @see http://developer.github.com/v3/repos/#create
+      # @example
+      #   client.create_repo('new-repo', description: 'New repository.', private: true)
+      def create_repo(name, options={})
+        post "/user/repos", auth_params, options.merge(name: name)
+      end
+
+      # Delete a repository.
+      # 
+      # Requires authentication.
+      #
+      # @param repo [String] Name of repository to delete.
+      # @return [Boolean] True if successful, false if not.
+      # @see http://developer.github.com/v3/repos/#delete-a-repository
+      # @example
+      #   client.delete_repo('repo-name')
+      def delete_repo(repo)
+        delete "/repos/#{login}/#{repo}", auth_params, true
+      end
+
+      # Get organization repositories.
+      #
+      # @param org [String] Organization name.
+      # @return [Array] List of all repositories for org.
+      # @see http://developer.github.com/v3/repos/#list-organization-repositories
+      # @example
+      #   GitHub.org_repos('rails')
+      def org_repos(org)
+        get "/orgs/#{org}/repos"
+      end
+
+      # List contributors for a repository.
+      #
+      # @param owner [String] Owner of repository.
+      # @param repo [String] Repository name.
+      # @return [Array] List of contributors.
+      # @see http://developer.github.com/v3/repos/#list-contributors
+      # @example
+      #   GitHub.contributors('caseyscarborough','github')
+      def contributors(owner, repo)
+        get "/repos/#{owner}/#{repo}/contributors"
+      end
+
+      # List languages for a repository.
+      #
+      # @param owner [String] Owner of repository.
+      # @param repo [String] Repository name.
+      # @return [Hash] Language information.
+      # @see http://developer.github.com/v3/repos/#list-languages
+      # @example
+      #   GitHub.languages('caseyscarborough','github')
+      def languages(owner, repo)
+        get "/repos/#{owner}/#{repo}/languages"
+      end
+
+      # def teams(owner, repo)
+      #   get "/repos/#{owner}/#{repo}/teams"
+      # end
+
+      # List tags for a repository.
+      #
+      # @param owner [String] Owner of repository.
+      # @param repo [String] Repository name.
+      # @return [Array] List of tags and their information.
+      # @see http://developer.github.com/v3/repos/#list-tags
+      # @example
+      #   GitHub.tags('caseyscarborough','github')
+      def tags(owner, repo)
+        get "/repos/#{owner}/#{repo}/tags"
+      end
+
+      # List branches for a repository.
+      #
+      # @param owner [String] Owner of repository.
+      # @param repo [String] Repository name.
+      # @return [Array] List of brances and their information. 
+      # @see http://developer.github.com/v3/repos/#list-branches
+      # @example
+      #   GitHub.branches('caseyscarborough','github')
+      def branches(owner, repo)
+        get "/repos/#{owner}/#{repo}/branches"
+      end
+
+      # Get information about a branch.
+      #
+      # @param owner [String] Owner of repository.
+      # @param repo [String] Repository name.
+      # @param branch [String] Branch name.
+      # @see http://developer.github.com/v3/repos/#get-branch
+      # @example
+      #   GitHub.branch('caseyscarborough','github','master')
+      def branch(owner, repo, branch)
+        get "/repos/#{owner}/#{repo}/branches/#{branch}"
+      end
+
+    end
+  end
+end

data/lib/github_api_v3/client/users.rb

@@ -0,0 +1,178 @@
+ module GitHub
+  class Client
+
+    # Contains methods for the Users API.
+    #
+    # @see http://developer.github.com/v3/users/
+    module Users
+      
+      # Returns a single user.
+      #
+      # If called without the username parameter, it will return the
+      # currently authenticated user.
+      #
+      # @param username [String] A GitHub username.
+      # @return [Hash]
+      # @see http://developer.github.com/v3/users/#get-a-single-user
+      # @see http://developer.github.com/v3/users/#get-the-authenticated-user
+      # @example
+      #   GitHub.user('caseyscarborough')
+      def user(username=nil)
+        if username
+          get "/users/#{username}"
+        else
+          get '/user', auth_params
+        end
+      end
+
+      # Returns a list of all GitHub users.
+      #
+      # @return [Array]
+      # @see http://developer.github.com/v3/users/#get-all-users
+      def users
+        get '/users'
+      end
+
+      # Get all emails for an authenticated user.
+      #
+      # @return [Array]
+      # @see http://developer.github.com/v3/users/emails/#list-email-addresses-for-a-user
+      # @example
+      #   client = GitHub::Client.new(login: 'username', access_token: 'abcdefghijklmnopqrstuvwxyz12345')
+      #   client.emails # => ["email@example.com", "email2@example.com"]
+      def emails
+        get '/user/emails', auth_params
+      end
+
+      # Follow a user.
+      #
+      # Requires authentication.
+      #
+      # @param username [String] Username of the user to follow.
+      # @return [Boolean] True on success.
+      # @see http://developer.github.com/v3/users/followers/#follow-a-user
+      # @example
+      #   client.follow('caseyscarborough')
+      def follow(username)
+        put "/user/following/#{username}", auth_params, true
+      end
+
+      # Checks to see if a user is following another user.
+      #
+      # @param username [String] The user following.
+      # @param target_username [String] The target user.
+      # @return [Boolean] True if user does follow target user.
+      # @see http://developer.github.com/v3/users/followers/#check-if-one-user-follows-another
+      # @example
+      #   GitHub.follows?('caseyscarborough', 'matz')
+      def follows?(username, target_username)
+        response = self.class.get "/users/#{username}/following/#{target_username}"
+        response.code == 204
+      end
+
+      # List a user's followers.
+      #
+      # If username is left blank, returns the currently authenticated user's
+      # list of followers.
+      #
+      # @param username [String] The username to get a list of followers for.
+      # @return [Array] Array of hashes of each user.
+      # @see http://developer.github.com/v3/users/followers/#list-followers-of-a-user
+      # @example
+      #   GitHub.followers('caseyscarborough')
+      # @example
+      #   # Get authenticated user's followers
+      #   client.followers
+      def followers(username=nil)
+        if username
+          get "/users/#{username}/followers"
+        else
+          get '/user/followers', auth_params
+        end
+      end
+
+      # List users who a specific user is following.
+      #
+      # @param username [String] The username of the user to get the list of users they arefollowing.
+      # @return [Array] Array of hashes of each user.
+      # @see http://developer.github.com/v3/users/followers/#list-users-followed-by-another-user
+      # @example
+      #   GitHub.following('caseyscarborough')
+      def following(username)
+        get "/users/#{username}/following"
+      end
+
+      # Check if an authenticated user is following another user.
+      #
+      # Requires the user to be authenticated.
+      #
+      # @param username [String] The username of the user to check against.
+      # @return [Boolean] True if user does follow the target user, false if not.
+      # @example
+      #   client.following?('caseyscarborough')
+      def following?(username)
+        response = self.class.get "/user/following/#{username}", query: auth_params
+        response.code == 204
+      end
+
+      # Unfollow a user.
+      #
+      # Requires authentication.
+      #
+      # @param username [String] The username of the user to unfollow.
+      # @return [Boolean] True if successful, false otherwise.
+      # @example
+      #   client.unfollow('matz')
+      def unfollow(username)
+        delete "/user/following/#{username}", auth_params, true
+      end
+
+      # Get a list of public keys for a user.
+      #
+      # If username left blank, get currently authenticated user's keys.
+      #
+      # @param username [String] The username to get public keys for.
+      # @return [Array] Array of hashes of public keys.
+      # @example
+      #   GitHub.keys('username')
+      # @example
+      #   client.keys
+      def keys(username=nil)
+        if username
+          get "/users/#{username}/keys"
+        else
+          get '/user/keys', auth_params
+        end
+      end
+
+      # Get a public key.
+      #
+      # Requires authentication.
+      #
+      # @param id [Integer] The id of the key to retrieve.
+      # @return [Hash]
+      # @example
+      #   client.key(123)
+      def key(id)
+        get "/user/keys/#{id}", auth_params
+      end
+
+      # Remove a public key from a user's account.
+      #
+      # Requires authentication.
+      #
+      # @param id [Integer] The id of the integer to delete.
+      # @return [Boolean] True if success, false if not.
+      # @example
+      #   client.delete_key(123)
+      def delete_key(id)
+        delete "/user/keys/#{id}", auth_params, true
+      end
+      
+      def events(username)
+        get "/users/#{username}/events"
+      end
+    end
+  
+  end
+end