github_api 0.3.5 → 0.3.6

data/lib/github_api/repos/keys.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module Github
+  class Repos
+    module Keys
+
+      VALID_KEY_PARAM_NAMES = %w[ title key ].freeze
+
+      # List deploy keys
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.keys 'user-name', 'repo-name'
+      #  @github.repos.keys 'user-name', 'repo-name' { |key| ... }
+      #
+      def keys(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/keys", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # Get a key
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.get_key 'user-name', 'repo-name', 'key-id'
+      #
+      def get_key(user_name, repo_name, key_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of key_id
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/keys/#{key_id}", params)
+      end
+
+      # Create a key
+      #
+      # = Inputs
+      # * <tt>:title</tt> - Required string.
+      # * <tt>:key</tt> - Required string.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.create_key 'user-name', 'repo-name',
+      #    "title" => "octocat@octomac",
+      #    "key" =>  "ssh-rsa AAA..."
+      #
+      def create_key(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+
+        raise ArgumentError, "Required params are: #{VALID_KEY_PARAM_NAMES.join(', ')}" unless _validate_inputs(VALID_KEY_PARAM_NAMES, params)
+
+        post("/repos/#{user}/#{repo}/keys", params)
+      end
+
+      # Edit a key
+      #
+      # = Inputs
+      # * <tt>:title</tt> - Required string.
+      # * <tt>:key</tt> - Required string.
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.create_key 'user-name', 'repo-name',
+      #    "title" => "octocat@octomac",
+      #    "key" =>  "ssh-rsa AAA..."
+      #
+      def edit_key(user_name, repo_name, key_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of key_id
+
+        _normalize_params_keys(params)
+        _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+
+        patch("/repos/#{user}/#{repo}/keys/#{key_id}", params)
+      end
+
+      # Delete key
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.delete_key 'user-name', 'repo-name', 'key-id'
+      #
+      def delete_key(user_name, repo_name, key_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of key_id
+        _normalize_params_keys(params)
+
+        delete("/repos/#{user}/#{repo}/keys/#{key_id}", params)
+      end
+
+    end # Keys
+  end # Repos
+end # Github

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+module Github
+  class Repos
+    module PubSubHubbub
+
+      # Subscribe to existing topic through pubsubhubbub
+      #
+      # = Parameters
+      # * topic - Required string - The URI of the GitHub repository to subscribe to. The path must be in the format of /:user/:repo/events/:event.
+      # * callback - Required string - The URI to receive the updates to the topic.
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.subscribe 'https://github.com/:user/:repo/events/push',
+      #    'github://Email?address=peter-murach@gmail.com',
+      #    :verify => 'sync',
+      #    :secret => '...'
+      #
+      def subscribe(topic, callback, params={})
+        _validate_presence_of topic, callback
+        _normalize_params_keys(params)
+        _merge_action!("subscribe", topic, callback, params)
+
+        post("/hub", params)
+      end
+
+      # Unsubscribe from existing topic though pubsubhubbub
+      #
+      #
+      def unsubscribe(topic, callback, params={})
+        _validate_presence_of topic, callback
+        _normalize_params_keys(params)
+        _merge_action!("unsubscribe", topic, callback, params)
+
+        post("/hub", params)
+      end
+
+      # Subscribe repository to service hook through pubsubhubbub
+      #
+      # = Parameters
+      # * repo-name - Required string,
+      # * service-name - Required string
+      # * <tt>:event</tt> - Required hash key for the type of event. The default event is <tt>push</tt>
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.repos.subscribe_service 'user-name', 'repo-name', 'campfire',
+      #    :subdomain => 'github',
+      #    :room => 'Commits',
+      #    :token => 'abc123',
+      #    :event => 'watch'
+      #
+      def subscribe_service(user_name, repo_name, service_name, params={})
+        _validate_presence_of user_name, repo_name, service_name
+        _normalize_params_keys(params)
+        event = params.delete('event') || 'push'
+        topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
+        callback = "github://#{service_name}?#{params.serialize}"
+
+        subscribe(topic, callback)
+      end
+      alias :subscribe_repository :subscribe_service
+
+      # Subscribe repository to service hook through pubsubhubbub
+      #
+      # = Parameters
+      # * repo-name - Required string,
+      # * service-name - Required string
+      # * <tt>:event</tt> - Optional hash key for the type of event. The default event is <tt>push</tt>
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.repos.unsubscribe_service 'user-name', 'repo-name', 'campfire'
+      #
+      def unsubscribe_service(user_name, repo_name, service_name, params={})
+        _validate_presence_of user_name, repo_name, service_name
+        _normalize_params_keys(params)
+        event = params.delete('event') || 'push'
+        topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
+        callback = "github://#{service_name}"
+
+        unsubscribe(topic, callback)
+      end
+      alias :unsubscribe_repository :unsubscribe_service
+
+    private
+
+      def _merge_action!(action, topic, callback, params) # :nodoc:
+        options = {
+          "hub.mode"     => action.to_s,
+          "hub.topic"    => topic.to_s,
+          "hub.callback" => callback,
+          "hub.verify"   => params.delete('verify') || 'sync',
+          "hub.secret"   => params.delete('secret') || ''
+        }
+        params.merge! options
+      end
+
+    end # PubSubHubbub
+  end # Repos
+end # Github

data/lib/github_api/repos/watching.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+
+module Github
+  class Repos
+    module Watching
+
+      # List repo watchers
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+      #  @github.repos.watchers
+      #  @github.repos.watchers { |watcher| ... }
+      #
+      def watchers(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/watchers", params)
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # List repos being watched by a user
+      #
+      # = Examples
+      #  @github = Github.new :user => 'user-name'
+      #  @github.repos.watched
+      #
+      # List repos being watched by the authenticated user
+      #
+      # = Examples
+      #  @github = Github.new :oauth_token => '...'
+      #  @github.repos.watched
+      #
+      def watched(user_name=nil, params={})
+        _update_user_repo_params(user_name)
+        _normalize_params_keys(params)
+
+        response = if user
+          get("/users/#{user}/watched", params)
+        else
+          get("/user/watched", params)
+        end
+        return response unless block_given?
+        response.each { |el| yield el }
+      end
+
+      # Check if you are watching a repository
+      #
+      # Returns <tt>true</tt> if this repo is watched by you, <tt>false</tt> otherwise
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.watching? 'user-name', 'repo-name'
+      #
+      def watching?(user_name, repo_name, params={})
+        _validate_presence_of user_name, repo_name
+        _normalize_params_keys(params)
+        get("/user/watched/#{user_name}/#{repo_name}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
+      end
+
+      # Watch a repository
+      #
+      # You need to be authenticated to watch a repository
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.start_watching 'user-name', 'repo-name'
+      #
+      def start_watching(user_name, repo_name, params={})
+        _validate_presence_of user_name, repo_name
+        _normalize_params_keys(params)
+        put("/user/watched/#{user_name}/#{repo_name}", params)
+      end
+
+      # Stop watching a repository
+      #
+      # You need to be authenticated to stop watching a repository.
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.start_watching 'user-name', 'repo-name'
+      #
+      def stop_watching(user_name, repo_name, params={})
+        _validate_presence_of user_name, repo_name
+        _normalize_params_keys(params)
+        delete("/user/watched/#{user_name}/#{repo_name}", params)
+      end
+
+    end # Watching
+  end # Repos
+end # Github

data/lib/github_api/request.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require 'base64'
+require 'addressable/uri'
+require 'multi_json'
+
+module Github
+  # Defines HTTP verbs
+  module Request
+
+    METHODS = [:get, :post, :put, :delete, :patch]
+    METHODS_WITH_BODIES = [ :post, :put, :patch ]
+
+    TOKEN_REQUIRED_REGEXP = [
+      /repos\/.*\/.*\/comments/,
+    ]
+
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    def patch(path, params={}, options={})
+      request(:patch, path, params, options)
+    end
+
+    def post(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    def put(path, params={}, options={})
+      request(:put, path, params, options)
+    end
+
+    def delete(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
+    def request(method, path, params, options)
+      if !METHODS.include?(method)
+        raise ArgumentError, "unkown http method: #{method}"
+      end
+      _extract_mime_type(params, options)
+
+      puts "EXECUTED: #{method} - #{path} with #{params} and #{options}" if ENV['DEBUG']
+
+      response = connection(options).send(method) do |request|
+        case method.to_sym
+        when *(METHODS - METHODS_WITH_BODIES)
+          request.url(path, params)
+        when *METHODS_WITH_BODIES
+          request.path = path
+          request.body = MultiJson.encode(_process_params(params)) unless params.empty?
+        end
+      end
+      response.body
+    end
+
+    private
+
+    def _process_params(params) # :nodoc:
+      return params['data'] if params.has_key?('data')
+      return params
+    end
+
+    def _extract_mime_type(params, options) # :nodoc:
+      options['resource']  = params.delete('resource') || ''
+      options['mime_type'] = params.delete('mime_type')
+    end
+
+    # no need for this smizzle
+    def formatted_path(path, options={})
+      [ path, options.fetch(:format, format) ].compact.join('.')
+    end
+
+    def basic_auth(login, password) # :nodoc:
+      auth = Base64.encode("#{login}:#{password}")
+      auth.gsub!("\n", "")
+    end
+
+    def token_auth
+    end
+
+  end # Request
+end # Github

data/lib/github_api/request/basic_auth.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'base64'
+
+module Github
+  module Request
+    class BasicAuth < Faraday::Middleware
+      dependency 'base64'
+
+      def call(env)
+        env[:request_headers].merge!('Authorization' => "Basic #{@auth}\"")
+
+        @app.call env
+      end
+
+      def initialize(app, *args)
+        @app = app
+        credentials = ""
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        if options.has_key? :login
+          credentials = "#{options[:login]}:#{options[:password]}"
+        elsif options.has_key? :basic_auth
+          credentials = "#{options[:basic_auth]}"
+        end
+        @auth = Base64.encode64(credentials)
+        @auth.gsub!("\n", "")
+      end
+    end # BasicAuth
+  end # Request
+end # Github

data/lib/github_api/request/caching.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  module Request
+    class Caching < Faraday::Middleware
+      attr_reader :cache
+
+      def initialize(app, cache = nil, options={})
+        super(app)
+        @cache = cache || Proc.new{}.call
+      end
+
+      def call(env)
+        if env[:method] == :get
+          # TODO choose cache method
+          # file_store
+          # mem_cache_store
+          # memory_store
+        else
+          @app.call(env)
+        end
+      end
+
+      def cache_key
+        url = env[:url].dup
+        if url.query
+        end
+      end
+    end
+  end # Request
+end # Github