github_api 0.2.1 → 0.2.2

data/lib/github_api/api.rb

@@ -6,6 +6,7 @@ require 'github_api/request'
 require 'github_api/mime_type'
 require 'github_api/core_ext/hash'
 require 'github_api/core_ext/array'
+require 'github_api/compatibility'
 
 module Github
 

data/lib/github_api/compatibility.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+if RUBY_VERSION < "1.9"
+
+  def ruby_18 #:nodoc:
+    yield
+  end
+
+  def ruby_19 #:nodoc:
+    false
+  end
+
+else
+
+  def ruby_18 #:nodoc:
+    false
+  end
+
+  def ruby_19 #:nodoc:
+    yield
+  end
+
+end

data/lib/github_api/connection.rb

@@ -37,12 +37,12 @@ module Github
 
       # parse(options['resource'], options['mime_type'] || mime_type) if options['mime_type']
       debugger
-
-      merged_options = if connection_options.empty?
-        header_options
-      else
-        connection_options.merge(header_options)
-      end
+#       merged_options = if connection_options.empty?
+#         header_options.merge(options)
+#       else
+#         connection_options.merge(header_options)
+#       end
+      merged_options = header_options.merge(options)
 
       clear_cache unless options.empty?
 

data/lib/github_api/orgs.rb

@@ -17,7 +17,7 @@ module Github
       email
       location
       name
-    ]
+    ].freeze
 
     # Creates new Orgs API
     def initialize(options = {})
@@ -47,6 +47,8 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :list_orgs :orgs
+    alias :list_organizations :orgs
 
     # Get properties for a single organization
     #
@@ -58,6 +60,8 @@ module Github
       _validate_presence_of org_name
       get("/orgs/#{org_name}")
     end
+    alias :get_org :org
+    alias :organisation :org
 
     # Edit organization
     #
@@ -85,6 +89,7 @@ module Github
 
       patch("/orgs/#{org_name}", params)
     end
+    alias :edit_organization :edit_org
 
   end # Orgs
 end # Github

data/lib/github_api/orgs/members.rb

@@ -6,15 +6,16 @@ module Github
 
       # List members
       #
-      # List all users who are members of an organization. A member is a user 
-      # that belongs to at least 1 team in the organization. 
-      # If the authenticated user is also a member of this organization then 
-      # both concealed and public members will be returned. 
+      # List all users who are members of an organization. A member is a user
+      # that belongs to at least 1 team in the organization.
+      # If the authenticated user is also a member of this organization then
+      # both concealed and public members will be returned.
       # Otherwise only public members are returned.
       #
       # = Examples
       #  @github = Github.new
       #  @github.orgs.members 'org-name'
+      #  @github.orgs.members 'org-name' { |memb| ... }
       #
       def members(org_name, params={})
         _validate_presence_of org_name
@@ -23,6 +24,7 @@ module Github
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :list_members :members
 
       # Check if user is a member of an organization
       #
@@ -38,6 +40,7 @@ module Github
       rescue Github::ResourceNotFound
         false
       end
+      alias :is_member? :member?
 
       # Remove a member
       # Removing a user from this list will remove them from all teams and
@@ -52,12 +55,14 @@ module Github
         _normalize_params_keys(params)
         delete("/orgs/#{org_name}/members/#{member_name}", params)
       end
+      alias :remove_member :delete_member
 
       # List public members
       # Members of an organization can choose to have their membership publicized or not.
       # = Examples
       #  @github = Github.new
       #  @github.orgs.public_members 'org-name'
+      #  @github.orgs.public_members 'org-name' { |memb| ... }
       #
       def public_members(org_name, params={})
         _validate_presence_of org_name
@@ -66,6 +71,8 @@ module Github
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :list_public_members :public_members
+
       # Get if a user is a public member of an organization
       #
       # = Examples
@@ -92,6 +99,8 @@ module Github
         _normalize_params_keys(params)
         put("/orgs/#{org_name}/public_members/#{member_name}", params)
       end
+      alias :make_public :publicize
+      alias :publicize_membership :publicize
 
       # Conceal a user’s membership
       #
@@ -104,6 +113,7 @@ module Github
         _normalize_params_keys(params)
         delete("/orgs/#{org_name}/public_members/#{member_name}", params)
       end
+      alias :conceal_membership :conceal
 
     end # Members
   end # Orgs

data/lib/github_api/orgs/teams.rb

@@ -7,9 +7,9 @@ module Github
     # Api calls that require explicit permissions are noted.
     module Teams
 
-      VALID_TEAM_PARAM_NAMES = %w[ name repo_names permission ]
+      VALID_TEAM_PARAM_NAMES = %w[ name repo_names permission ].freeze
       VALID_TEAM_PARAM_VALUES = {
-        'permission' => %w[ pull push admin ]
+        'permission' => %w[ pull push admin ].freeze
       }
 
       # List teams
@@ -22,10 +22,11 @@ module Github
         _validate_presence_of org_name
         _normalize_params_keys(params)
 
-        get("/orgs/#{org_name}/teams", params)
+        response = get("/orgs/#{org_name}/teams", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :list_teams :teams
 
       # Get a team
       #
@@ -39,6 +40,7 @@ module Github
 
         get("/teams/#{team_name}", params)
       end
+      alias :get_team :team
 
       # Create a team
       #
@@ -71,7 +73,7 @@ module Github
         post("/orgs/#{org_name}/teams", params)
       end
 
-      # Create a team
+      # Edit a team
       # In order to edit a team, the authenticated user must be an owner of the org that the team is associated with.
       #
       # = Inputs
@@ -123,10 +125,11 @@ module Github
         _validate_presence_of team_name
         _normalize_params_keys(params)
 
-        response = get("/teams/:id/members", params)
+        response = get("/teams/#{team_name}/members", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :list_team_members :team_members
 
       # Check if a user is a member of a team
       #
@@ -155,6 +158,7 @@ module Github
         _normalize_params_keys(params)
         put("/teams/#{team_name}/members/#{member_name}", params)
       end
+      alias :add_member :add_team_member
 
       # Remove a team member
       # In order to remove a user from a team, the authenticated user must
@@ -171,6 +175,7 @@ module Github
         _normalize_params_keys(params)
         delete("/teams/#{team_name}/members/#{member_name}", params)
       end
+      alias :remove_member :remove_team_member
 
       # List team repositories
       #
@@ -179,19 +184,20 @@ module Github
       #  @github.orgs.team_repos 'team-name'
       #
       def team_repos(team_name, params={})
-        _validate_presence_of team_name, member_name
+        _validate_presence_of team_name
         _normalize_params_keys(params)
 
         response = get("/teams/#{team_name}/repos", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :team_repositories :team_repos
 
       # Check if a repository belongs to a team
       #
       # = Examples
       #  @github = Github.new :oauth_token => '...'
-      #  @github.orgs.team_repo? 'team-name'
+      #  @github.orgs.team_repo? 'team-name', 'user-name', 'repo-name'
       #
       def team_repo?(team_name, user_name, repo_name, params={})
         _validate_presence_of team_name, user_name, repo_name
@@ -201,6 +207,7 @@ module Github
       rescue Github::ResourceNotFound
         false
       end
+      alias :team_repository? :team_repo?
 
       # Add a team repository
       # In order to add a repo to a team, the authenticated user must be
@@ -215,6 +222,7 @@ module Github
         _normalize_params_keys(params)
         put("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
       end
+      alias :add_team_repository :add_team_repo
 
       # Remove a team repository
       # In order to add a repo to a team, the authenticated user must be
@@ -230,6 +238,7 @@ module Github
         _normalize_params_keys(params)
         delete("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
       end
+      alias :remove_team_repository :remove_team_repo
 
     end # Teams
   end # Orgs

data/lib/github_api/repos/downloads.rb

@@ -3,73 +3,151 @@
 module Github
   class Repos
     module Downloads
-      
+
       REQUIRED_PARAMS = %w[ name size ]
-      VALID_PARAMS = %w[ name size description content_type ]
 
-      REQUIRED_S3_PARAMS = %w[ key acl success_action_status Filename AWSAccessKeyId Policy Signature Content-Type file ]
+      VALID_DOWNLOAD_PARAM_NAMES = %w[
+        name
+        size
+        description
+        content_type
+      ].freeze
+
+      REQUIRED_S3_PARAMS = %w[
+        path
+        acl
+        name
+        accesskeyid
+        policy
+        signature
+        mime_type
+      ].freeze
+
+      # Status code for successful upload to Amazon S3 service
+      SUCCESS_STATUS = 201
 
       # List downloads for a repository
       #
-      # GET /repos/:user/:repo/downloads
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.downloads 'user-name', 'repo-name'
+      #  @github.repos.downloads 'user-name', 'repo-name' { |downl| ... }
       #
-      def downloads(user, repo)
-        get("/repos/#{user}/#{repo}/downloads")
+      def downloads(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}/downloads")
+        return response unless block_given?
+        response.each { |el| yield el }
       end
+      alias :list_downloads :downloads
+      alias :get_downloads :downloads
 
       # Get a single download
       #
-      # GET /repos/:user/:repo/downloads/:id
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.download 'user-name', 'repo-name'
       #
-      def get_download(user, repo, download_id)
+      def download(user_name, repo_name, download_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of download_id
+        _normalize_params_keys(params)
+
         get("/repos/#{user}/#{repo}/downloads/#{download_id}")
       end
+      alias :get_download :download
 
       # Delete download from a repository
       #
-      # DELETE /repos/:user/:repo/downloads/:id
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.delete_download 'user-name', 'repo-name', 'download-id'
       #
-      def delete_download(user, repo, download_id)
+      def delete_download(user_name, repo_name, download_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of download_id
+        _normalize_params_keys(params)
+
         delete("/repos/#{user}/#{repo}/downloads/#{download_id}")
       end
 
-      # Creating a new download is a two step process. 
+      # Creating a new download is a two step process.
       # You must first create a new download resource using this method.
       # Response from this method is to be used in #upload method.
       #
-      # POST /repos/:user/:repo/downloads
+      # = Inputs
+      # * <tt>:name</tt> - Required string - name of the file that is being created.
+      # * <tt>:size</tt> - Required number - size of file in bytes.
+      # * <tt>:description</tt> - Optional string
+      # * <tt>:content_type</tt> - Optional string
       #
-      def create_download(user, repo, params={})
+      # = Examples
+      #  @github = Github.new
+      #  @github.repos.create_download 'user-name', 'repo-name',
+      #    "name" =>  "new_file.jpg",
+      #    "size" => 114034,
+      #    "description" => "Latest release",
+      #    "content_type" => "text/plain"
+      #
+      def create_download(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)
-        raise ArgumentError, "expected following inputs to the method: #{REQUIRED_INPUTS.join(', ')}" unless _valid_inputs(REQUIRED_PARAMS, params)
-        _filter_params_keys(VALID_PARAMS, params)
+        _filter_params_keys(VALID_DOWNLOAD_PARAM_NAMES, params)
+
+        raise ArgumentError, "Required parameters are: #{REQUIRED_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_PARAMS, params)
 
         post("/repos/#{user}/#{repo}/downloads", params)
       end
-        
-      # Upload a file to Amazon, using the reponse instance from 
-      # Github::Repos::Downloads#create. This can be done by passing 
+
+      # Upload a file to Amazon, using the reponse instance from
+      # Github::Repos::Downloads#create_download. This can be done by passing
       # the response object as an argument to upload method.
       #
-      def upload(result, file)
+      # = Parameters
+      # * <tt>resource</tt> - Required Hashie::Mash -resource of the create_download call
+      # * <tt>:size</tt> - Required number - size of file in bytes.
+      #
+      def upload(resource, filename)
+        _validate_presence_of resource, filename
+        raise ArgumentError, 'Need to provied resource of Github::Repose::Downloads#create_download call' unless resource.is_a? Hashie::Mash
+
         REQUIRED_S3_PARAMS.each do |key|
-          raise ArgumentError, "expected following keys: #{REQUIRED_S3_PARAMS.join(', ')}" unless result.respond_to?(key) 
+          raise ArgumentError, "Expected following key: #{key}" unless resource.respond_to?(key)
         end
-        
+
         # TODO use ordered hash if Ruby < 1.9
+        hash = ruby_18 {
+          require 'active_support'
+          ActiveSupport::OrderedHash.new } || ruby_19 { Hash.new }
+
         mapped_params = {
-          "key"                   => result.path,
-          "acl"                   => result.acl,
-          "success_action_status" => 201,
-          "Filename"              => result.name,
-          "AWSAccessKeyId" => result.accesskeyid,
-          "Policy" => result.policy,
-          "Signature" => result.signature,
-          "Content-Type" => result.mime_type,
-          "file" => file 
+          'key'                   => resource.path,
+          'acl'                   => resource.acl,
+          'success_action_status' => SUCCESS_STATUS,
+          'Filename'              => resource.name,
+          'AWSAccessKeyId'        => resource.accesskeyid,
+          'Policy'                => resource.policy,
+          'Signature'             => resource.signature,
+          'Content-Type'          => resource.mime_type,
+          'file'                  => prepend_at_for(filename.to_s)
         }
-        
-        post(result.s3_url, mapped_params)
+
+        post('', mapped_params, { :url => resource.s3_url })
+      end
+      alias :upload_to_s3 :upload
+      alias :upload_to_amazon :upload
+
+    private
+
+      def prepend_at_for(file)
+        /^@.*/ =~ file ? '@' + file : file
       end
 
     end # Downloads