github_api 0.3.5 → 0.3.6

data/lib/github_api/request/oauth2.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  module Request
+    class OAuth2 < Faraday::Middleware
+      dependency 'oauth2'
+
+      def call(env)
+#         puts "ENV: #{env.inspect}"
+#         puts "TOKEN : #{@token}"
+#         puts "APP: #{@app}"
+
+        # Extract parameters from the query
+        params = env[:url].query_values || {}
+
+        env[:url].query_values = { 'access_token' => @token }.merge(params)
+
+        token = env[:url].query_values['access_token']
+
+        env[:request_headers].merge!('Authorization' => "Token token=\"#{token}\"")
+
+        @app.call env
+      end
+
+      def initialize(app, *args)
+        @app = app
+        @token = args.shift
+      end
+    end # OAuth2
+  end # Request
+end # Github

data/lib/github_api/response.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  # Contains methods and attributes that act on the response returned from the 
+  # request
+  class Response < Faraday::Response::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    class << self
+      attr_accessor :parser
+    end
+
+    def self.define_parser(&block)
+      @parser = block
+    end
+
+    def response_type(env)
+      env[:response_headers][CONTENT_TYPE].to_s
+    end
+
+    def parse_response?(env)
+      env[:body].respond_to? :to_str
+    end
+
+  end # Response
+end # Github

data/lib/github_api/response/helpers.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::Helpers < Response
+
+    def on_complete(env)
+      env[:body].extend(Github::Result)
+      env[:body].instance_eval { @env = env }
+    end
+
+  end # Response::Helpers
+end # Github

data/lib/github_api/response/jsonize.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::Jsonize < Response
+    dependency 'multi_json'
+
+    define_parser do |body|
+      ::MultiJson.decode body
+    end
+
+    def parse(body)
+      case body
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        self.class.parser.call body
+      end
+    end
+  end # Response::Jsonize
+end # Github

data/lib/github_api/response/mashify.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::Mashify < Response
+    dependency 'hashie/mash'
+
+    define_parser do |body|
+      ::Hashie::Mash.new body
+    end
+
+    def parse(body)
+      case body
+      when Hash
+        self.class.parser.call body
+      when Array
+        body.map { |item| item.is_a?(Hash) ? self.class.parser.call(item) : item }
+      else
+        body
+      end
+    end
+  end # Response::Mashify
+end # Github

data/lib/github_api/response/raise_error.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'github_api/error'
+
+module Github
+  class Response::RaiseError < Faraday::Response::Middleware
+
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise Github::BadRequest.new(response_message(env), env[:response_headers])
+      when 401
+        raise Github::Unauthorised.new(response_message(env), env[:response_headers])
+      when 403
+        raise Github::Forbidden.new(response_message(env), env[:response_headers])
+      when 404
+        raise Github::ResourceNotFound.new(response_message(env), env[:response_headers])
+      when 500
+        raise Github::InternalServerError.new(response_message(env), env[:response_headers])
+      when 503
+        raise Github::ServiceUnavailable.new(response_message(env), env[:response_headers])
+      when 400...600
+        raise Github::Error.new(response_message(env), env[:response_headers])
+      end
+    end
+
+    def response_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]}#{env[:body]}"
+    end
+
+  end # Response::RaiseError
+end # Github

data/lib/github_api/result.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Github
+  module Result
+
+    RATELIMIT = 'X-RateLimit-Remaining'.freeze
+    CONTENT_TYPE = 'Content-Type'.freeze
+    CONTENT_LENGTH = 'content-length'.freeze
+
+    attr_reader :env
+
+    # Requests are limited to API v3 to 5000 per hour.
+    def ratelimit
+      loaded? ? @env[:response_headers][RATELIMIT] : nil
+    end
+
+    def content_type
+      loaded? ? @env[:response_headers][CONTENT_TYPE] : nil
+    end
+
+    def content_length
+      loaded? ? @env[:response_headers][CONTENT_LENGTH] : nil
+    end
+
+    def status
+      loaded? ? @env[:status] : nil
+    end
+
+    def success?
+      (200..299).include? status
+    end
+
+    def body
+      loaded? ? @env[:body] : nil
+    end
+
+    def loaded?
+      !!env
+    end
+
+  end # Result
+end # Github

data/lib/github_api/users.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+module Github
+  class Users < API
+    extend AutoloadHelper
+
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    autoload_all 'github_api/users',
+      :Emails    => 'emails',
+      :Followers => 'followers',
+      :Keys      => 'keys'
+
+    include Github::Users::Emails
+    include Github::Users::Followers
+    include Github::Users::Keys
+
+    VALID_USER_PARAMS_NAMES = %w[
+      name
+      email
+      blog
+      company
+      location
+      hireable
+      bio
+    ].freeze
+
+    # Creates new Repos API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # Get a single unauthenticated user
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.users.get_user 'user-name'
+    #
+    # Get the authenticated user
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.users.get_user
+    #
+    def get_user(user_name=nil, params={})
+      _normalize_params_keys(params)
+      if user_name
+        get("/users/#{user_name}", params)
+      else
+        get("/user", params)
+      end
+    end
+    alias :get_auth_user :get_user
+
+    # Update the authenticated user
+    #
+    # = Inputs
+    # * <tt>:name</tt> - Optional string
+    # * <tt>:email</tt> - Optional string - publically visible email address
+    # * <tt>:blog</tt> - Optional string
+    # * <tt>:company</tt> - Optional string
+    # * <tt>:location</tt> - Optional string
+    # * <tt>:hireable</tt> - Optional boolean
+    # * <tt>:bio</tt> - Optional string
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '..'
+    #  @github.users.update_user
+    #    "name" => "monalisa octocat",
+    #    "email" => "octocat@github.com",
+    #    "blog" => "https://github.com/blog",
+    #    "company" => "GitHub",
+    #    "location" => "San Francisco",
+    #    "hireable" => true,
+    #    "bio" => "There once..."
+    #
+    def update_user(params={})
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_USER_PARAMS_NAMES, params)
+      patch("/user", params)
+    end
+    alias :update_authenticated_user :update_user
+
+  end # Users
+end # Github

data/lib/github_api/users/emails.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Github
+  class Users
+    module Emails
+
+      # List email addresses for the authenticated user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.emails
+      #
+      def emails(params={})
+        get("/user/emails", params)
+      end
+
+      # Add email address(es) for the authenticated user
+      #
+      # = Inputs
+      # You can include a single email address or an array of addresses
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.add_email "octocat@github.com", "support@github.com"
+      #
+      def add_email(*args)
+        params = _extract_parameters(args)
+        params['data'] = [args].flatten
+        post("/user/emails", params)
+      end
+
+      # Delete email address(es) for the authenticated user
+      #
+      # = Inputs
+      # You can include a single email address or an array of addresses
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.delete_email "octocat@github.com", "support@github.com"
+      #
+      def add_email(*args)
+        params = _extract_parameters(args)
+        params['data'] = [args].flatten
+        delete("/user/emails", params)
+      end
+
+    end # Emails
+  end # Users
+end # Github

data/lib/github_api/users/followers.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module Github
+  class Users
+    module Followers
+
+      # List a user's followers
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.users.followers 'user-name'
+      #  @github.users.followers 'user-name' { |user| ... }
+      #
+      # List the authenticated user's followers
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.following
+      #  @github.users.following { |user| ... }
+      #
+      def followers(user_name=nil, params={})
+        _normalize_params_keys(params)
+        response = if user_name
+          get("/users/#{user_name}/followers", params)
+        else
+          get("/user/followers", params)
+        end
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # List who a user is following
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.users.following 'user-name'
+      #  @github.users.following 'user-name' { |user| ... }
+      #
+      # List who the authenicated user is following
+      #
+      # = Examples
+      #
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.following
+      #
+      def following(user_name=nil, params={})
+        _normalize_params_keys(params)
+        response = if user_name
+          get("/users/#{user_name}/following", params)
+        else
+          get("/user/following", params)
+        end
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # Check if you are following a user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.following? 'user-name'
+      #
+      def following?(user_name, params={})
+        _validate_presence_of user_name
+        _normalize_params_keys(params)
+        get("/user/following/#{user_name}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
+      end
+
+      # Follow a user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.follow 'user-name'
+      #
+      def follow(user_name, params={})
+        _validate_presence_of user_name
+        _normalize_params_keys(params)
+        put("/user/following/#{user_name}", params)
+      end
+
+      # Unfollow a user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.unfollow 'user-name'
+      #
+      def unfollow(user_name, params={})
+        _validate_presence_of user_name
+        _normalize_params_keys(params)
+        delete("/user/following/#{user_name}", params)
+      end
+
+    end # Followers
+  end # Users
+end # Github

data/lib/github_api/users/keys.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+module Github
+  class Users
+    module Keys
+
+      VALID_KEY_PARAM_NAMES = %w[ title key ].freeze
+
+      # List public keys for the authenticated user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.public_keys
+      #  @github.users.public_keys { |key| ... }
+      #
+      def public_keys(params={})
+        _normalize_params_keys(params)
+        response = get("/user/keys", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # Get a single pulic key for the authenticated user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.public_key 'key-id'
+      #
+      def public_key(key_id, params={})
+        _validate_presence_of key_id
+        _normalize_params_keys(params)
+        get("/user/keys/#{key_id}", params)
+      end
+
+      # Create a public key for the authenticated user
+      #
+      # = Inputs
+      # * <tt>:title</tt> - Required string
+      # * <tt>:key</tt> - Required string. sha key
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.create_key "title" => "octocat@octomac",
+      #    "key" => "ssh-rsa AAA..."
+      #
+      def create_key(params={})
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+        post("/user/keys", params)
+      end
+
+      # Update a public key for the authenticated user
+      #
+      # = Inputs
+      # * <tt>:title</tt> - Required string
+      # * <tt>:key</tt> - Required string. sha key
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.update_key 'key-id', "title" => "octocat@octomac",
+      #    "key" => "ssh-rsa AAA..."
+      #
+      def update_key(key_id, params={})
+        _validate_presence_of key_id
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+        patch("/user/keys/#{key_id}", params)
+      end
+
+      # Delete a public key for the authenticated user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.users.delete_key 'key-id'
+      #
+      def delete_key(key_id, params={})
+        _validate_presence_of key_id
+        _normalize_params_keys(params)
+        delete("/user/keys/#{key_id}", params)
+      end
+
+    end # Keys
+  end # Users
+end # Github