github-api-client 0.1.1 → 0.1.1.1

data/lib/github_api.rb

@@ -10,10 +10,15 @@ require 'yaml'
 require 'singleton'
 require 'active_record'
 
-module GitHub #:nodoc:
+# General placeholder for all of the GitHub API sweets
+module GitHub
+  # Keeps all the configuration stuff
   module Config
+    # Constant with defined all the paths used in the application
     Path = {:dir => ENV['HOME'] + "/.github", :dbfile => ENV['HOME'] + "/.github/github.db", :migrations => Gem.loaded_specs['github-api-client'].full_gem_path + "/db/migrate", :secrets => ENV['HOME'] + "/.github" + "/secrets.yml"}
     
+    # Sets up the database and migrates it
+    # @return [nil]
     def self.setup
       Dir.mkdir GitHub::Config::Path[:dir] rescue nil
       ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => GitHub::Config::Path[:dbfile]

data/lib/github_api/base.rb

@@ -2,6 +2,7 @@ module GitHub
   # Basic functionality inherited later
   class Base
     # Sends key= value signals at object, that inherits it
+    # @param [Hash] options to assign for an object
     def build(options = {})
       options.each_pair do |k, v|
         self.send "#{k.to_sym}=", v
@@ -12,6 +13,7 @@ module GitHub
     # == VERY DANGEROUS AND EVIL
     # Recursively gets all* GitHub Users, takes years to fetch
     # * - all that have at least one follower
+    # @return nil
     def self.sync
       puts "Synchronizing local database with GitHub"
       users = GitHub::User.all
@@ -24,11 +26,13 @@ module GitHub
         #user.get
         #user.get_followers
       end
+      nil
     end
      
     # Converts pitfalls from GitHub API differences into normal data
+    # @param [Hash] attributes GitHub API retrieved attributes to be parsed
+    # @return [Hash] parsed attributes, fully compatibile with local db
     def self.parse_attributes(attributes)
-      #p attributes
       {:name => :login, :username => :login, :fullname => :name, :followers => :followers_count, :repos => :public_repo_count, :created => :nil}.each do |k, v|
         unless v == :nil
           attributes[v] = attributes[k.to_s]
@@ -38,13 +42,11 @@ module GitHub
       attributes
     end
     
-    def to_ary #:nodoc:
+    # ActiveRecord fix that returns attributes
+    # @return [Hash] Attributes of the object
+    def to_ary
       return self.attributes
     end
-    
-    def method_missing(method, *args, &block) #:nodoc:
-      puts "Missing #{method}"
-    end
   end
   
   # Singleton class, that is used globally
@@ -56,6 +58,9 @@ module GitHub
     # === Objects
     # * GitHub::User - recognition by key 'user'
     # More to be added soon
+    # @deprecated Nothing uses it, but may come handy later
+    # @param [String] yaml a YAML content to be parsed
+    # @return [GitHub::User, Array]
     def self.build_from_yaml(yaml)
       yaml = YAML::load yaml
       object = case

data/lib/github_api/browser.rb

@@ -4,11 +4,14 @@ module GitHub
     include Singleton
     
     # Returnes root uri for GitHub API
+    # @return [String] Base GitHub API url for v2
     def self.base_uri
       "http://github.com/api/v2/yaml"
     end
     
     # Runs HTTP GET request at given uri
+    # @param [String] uri URI to be joined with base_uri and requested
+    # @return [String] request result
     def self.get(uri)
       uri = uri.gsub(" ","+")
       puts "Requesting #{URI.parse(self.base_uri + uri)}"
@@ -16,6 +19,8 @@ module GitHub
     end
     
     # Runs HTTP POST requests with options such as GitHub::User.auth_info
+    # @param [String] uri URI to be joined with base_uri and requested
+    # @return [String] request result
     def self.post(uri, options = {})
       uri = uri.gsub(" ","+")
       puts "Requesting #{URI.parse(self.base_uri + uri)} with options: #{options}"

data/lib/github_api/user.rb

@@ -6,6 +6,7 @@ module GitHub
     
     # Fetches info about current_user from GitHub
     # GitHub::User.new.build(:login => 'asd', :token => 'token').get #=> GitHub::User
+    # @return [GitHub::User] Chainable self object after syncing attributes with GitHub
     def get
       self.update_attributes YAML::load(GitHub::Browser.get("/user/show/#{self.login}"))['user']
       self
@@ -14,10 +15,15 @@ module GitHub
     # Static function, that gets information about GitHub::User by login.
     # === Examples
     #  GitHub::User.get('defunkt') #=> GitHub::User
+    # @param [String] login GitHub user login to fetch
+    # @return [GitHub::User] Newly created, in local database user synced with github
     def self.get(login)
       return GitHub::User.find_or_create_by_login YAML::load(GitHub::Browser.get("/user/show/#{login}"))['user']
     end
     
+    # Searches for users in GitHub database
+    # @param [String] login GitHub user login to search
+    # @return [Array<GitHub::User>] All users that matched login
     def self.search(login)
       users = []
       YAML::load(GitHub::Browser.get("/user/search/#{login}"))['users'].each do |user|
@@ -26,11 +32,21 @@ module GitHub
       users
     end
     
-    def set(route = [], options = {}) #:nodoc:
+    # Experimental function, requests POST transmission to custom path of GitHub API
+    # @param [Array] route Route splitted like: ['users', 'search', 'chacon']
+    # @param [Hash] options Options to pass with the request
+    # @option [Hash] options 'values[email]' => 'test@api.com'
+    def set(route = [], options = {})
       return GitHub::Browser.post "/#{route.join('/')}", options.merge(self.auth_info)
     end
     
     # End-user way to fetch information
+    # @param [Array<Symbol>] things Things to fetch for GitHub::User
+    # @option things [Symbol] :self Sync with GitHub Database
+    # @option things [Symbol] :followers Map followers from GitHub Database
+    # @return [GitHub::User] Chainable, updated User
+    # @see GitHub::User#get
+    # @see GitHub::User#get_followers
     def fetch(*things)
       things.each do |thing|
         case thing
@@ -42,6 +58,8 @@ module GitHub
     end
     
     # Executes when you got a real object
+    # @see GitHub::User#fetch
+    # @return GitHub::User Chainable after mapping followers association
     private 
     def get_followers
       users = YAML::load(GitHub::Browser.get "/user/show/#{login}/followers")['users']
@@ -59,8 +77,10 @@ module GitHub
       self
     end
     
-    # Returns an array with logins of GitHub::User followers
     public
+    # Returns an array with logins of GitHub::User followers
+    # @param [String] login GitHub login of which followers will be mapped
+    # @return [Array<GitHub::User>] Followers
     def self.get_followers(login)
       users = YAML::load(GitHub::Browser.get "/user/show/#{login}/followers")['users']
       
@@ -78,11 +98,16 @@ module GitHub
     
     # Collects information from authenticated user.
     # Used by post requests to authenticate
+    # @return [Hash] Collected from GitHub::User options for HTTP POST request authentication
     def auth_info
       {:login => self.login, :token => self.token}
     end
     
-    # Experimental, sets information about GitHub::User or returns authenticated :self 
+    # Experimental, sets information about GitHub::User or returns authenticated :self
+    # @param [String] login Login to which post request will be sent
+    # @param [Hash] options Options to include to a post request
+    # @option options [Hash] email 'values[email]' => 'test@api.com' - Sets user email to test@api.com if authenticated
+    # @return [String] Request retrieved data
     def post(login, options = {})
       if [:self, :me].include? login
         login = self.login

metadata

@@ -6,7 +6,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 1
   - 1
-  version: 0.1.1
+  - 1
+  version: 0.1.1.1
 platform: ruby
 authors: 
 - "Jakub Oko\xC5\x84ski"
@@ -76,7 +77,7 @@ files:
 - lib/github_api/user.rb
 - db/migrate/002_create_followings.rb
 - db/migrate/001_create_users.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/farnoy/github-api-client
 licenses: []