github_api 0.6.1 → 0.6.2

data/README.md

@@ -14,16 +14,6 @@ Supports all the API methods(nearly 200). It's build in a modular way, that is,
 ## Important!!
 Since version 0.5 the way the gem queries the GitHub api underwent important changes. It closely mirros the Github api hierarchy e.i. if you want to create a download resource, lookup the github api spec and issue the request as in `github.repos.downloads.create`
 
-```ruby
-Old style: github.pull_requests.create_request
-           github.pull_requests.pull_requests
-           github.pull_requests.pull_request
-
-New style: github.pull_requests.create
-           github.pull_requests.all
-           github.pull_requests.find
-```
-
 ## Installation
 
 Install the gem by issuing
@@ -46,12 +36,22 @@ Create a new client instance
 github = Github.new
 ```
 
-At this stage you can also supply various configuration parameters, such as `:user`,`:repo`, `:org`, `:oauth_token`, `:login`, `:password` or `:basic_auth` which are used throughout the API
+At this stage you can also supply various configuration parameters, such as `:user`,`:repo`, `:org`, `:oauth_token`, `:basic_auth`, `:endpoint` which are used throughout the API. These can be passed directly as hash options:
 
 ```ruby
 github = Github.new oauth_token: 'token'
 ```
 
+Alternatively, you can configure the Github settings by passing a block, for instance, with custom enteprise endpoint like
+
+```ruby
+github = Github.new do |config|
+  config.endpoint    = 'https://github.company.com/api/v3'
+  config.oauth_token = 'token'
+  config.adapter     = :net_http
+end
+```
+
 You can authenticate either using OAuth authentication convenience methods(see section OAuth) or through basic authentication by passing your login and password credentials
 
 ```ruby
@@ -88,6 +88,29 @@ repos.branches do |branch|
 end
 ```
 
+## Inputs
+
+Some API methods apart from required parameters such as username, repository name
+or organisation name, allow you to switch the way the data is returned to you, for instance
+
+```ruby
+github = Github.new
+github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea'
+# => gets a tree
+
+github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea',
+  recursive: true # => gets a whole tree recursively
+```
+
+by passing a block you can iterate over the file tree
+
+```ruby
+github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea',
+  recursive: true do |file|
+    puts file.path
+end
+```
+
 ## API
 
 Main API methods are grouped into the following classes that can be instantiated on their own
@@ -116,72 +139,29 @@ github.users.followers.following 'wycats' # => returns true if following, otherw
 ```
 
 For specification on all available methods go to http://developer.github.com/v3/ or
-read the rdoc, all methods are documented there with examples of usage. 
-
-Alternatively, you can find out a specific class supported methods by calling `actions` in your `irb`:
-
-```ruby
->> Github::Repos.actions
----
-|--> all
-|--> branches
-|--> collaborators
-|--> commits
-|--> contribs
-|--> contributors
-|--> create
-|--> downloads
-|--> edit
-|--> find
-|--> forks
-|--> get
-|--> hooks
+read the rdoc, all methods are documented there with examples of usage.
+
+Alternatively, you can find out supported methods by calling `actions` on a class instance in your `irb`:
+
+```ruby
+>> Github::Repos.actions                    >> github.issues.actions
+---                                         ---
+|--> all                                    |--> all
+|--> branches                               |--> comments
+|--> collaborators                          |--> create
+|--> commits                                |--> edit
+|--> contribs                               |--> events
+|--> contributors                           |--> find
+|--> create                                 |--> get
+|--> downloads                              |--> labels
+|--> edit                                   |--> list
+|--> find                                   |--> list_repo
+|--> forks                                  |--> list_repository
+|--> get                                    |--> milestones
+|--> hooks                                  ...
 ...
 ```
 
-or you can call `actions` on chained query:
-
-```
->> github.issues.actions
----
-|--> all
-|--> comments
-|--> create
-|--> edit
-|--> events
-|--> find
-|--> get
-|--> labels
-|--> list
-|--> list_repo
-|--> list_repository
-|--> milestones
----
-```
-
-## Inputs
-
-Some API methods apart from required parameters such as username, repository name
-or organisation name, allow you to switch the way the data is returned to you, for instance
-
-```ruby
-github = Github.new
-github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea'
-# => gets a tree
-
-github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea',
-  recursive: true # => gets a whole tree recursively
-```
-
-by passing a block you can iterate over the file tree
-
-```ruby
-github.git_data.trees.get 'peter-murach', 'github', 'c18647b75d72f19c1e0cc8af031e5d833b7f12ea',
-  recursive: true do |file|
-    puts file.path
-end
-```
-
 ## OAuth
 
 In order to authenticate the user through OAuth2 on GitHub you need to

data/features/cassettes/git_data/tags/get.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/repos/wycats/thor/git/tags/ffbc56c0c2?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3.raw+json,application/vnd.github.beta.raw+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.6.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Server:
+      - nginx/1.0.13
+      Date:
+      - Wed, 11 Jul 2012 21:35:36 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 404 Not Found
+      X-Ratelimit-Limit:
+      - '5000'
+      Cache-Control:
+      - ''
+      X-Ratelimit-Remaining:
+      - '4999'
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6tWyk0tLk5MT1WyUvLLL1Fwyy/NS1GqBQB8+Ys1FwAAAA==
+    http_version: !!null 
+  recorded_at: Wed, 11 Jul 2012 21:35:36 GMT
+recorded_with: VCR 2.2.0

data/features/cassettes/markdown/render.yml

@@ -0,0 +1,46 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: https://<BASIC_AUTH>@api.github.com/markdown?access_token=<TOKEN>
+    body: 
+      encoding: UTF-8
+      string: "{\"text\":\"Hello world\",\"mode\":\"gfm\",\"context\":\"<USER>/github_api_test\"}"
+    headers: 
+      Content-Type: 
+      - application/json
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Server: 
+      - nginx/1.0.13
+      Date: 
+      - Sun, 01 Jul 2012 19:15:21 GMT
+      Content-Type: 
+      - text/html;charset=utf-8
+      Connection: 
+      - keep-alive
+      Status: 
+      - 200 OK
+      Content-Length: 
+      - "18"
+      X-Ratelimit-Remaining: 
+      - "4998"
+      Etag: 
+      - "\"4114864e259a6fdcc545904ac07b9885\""
+      Cache-Control: 
+      - max-age=0, private, must-revalidate
+      X-Ratelimit-Limit: 
+      - "5000"
+    body: 
+      encoding: US-ASCII
+      string: <p>Hello world</p>
+    http_version: 
+  recorded_at: Sun, 01 Jul 2012 19:15:21 GMT
+recorded_with: VCR 2.2.0

data/features/cassettes/markdown/render_raw.yml

@@ -0,0 +1,46 @@
+--- 
+http_interactions: 
+- request: 
+    method: post
+    uri: https://<BASIC_AUTH>@api.github.com/markdown/raw?access_token=<TOKEN>
+    body: 
+      encoding: UTF-8
+      string: Hello cool world
+    headers: 
+      Content-Type: 
+      - text/plain
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Server: 
+      - nginx/1.0.13
+      Date: 
+      - Mon, 02 Jul 2012 21:12:15 GMT
+      Content-Type: 
+      - text/html;charset=utf-8
+      Connection: 
+      - keep-alive
+      Status: 
+      - 200 OK
+      X-Ratelimit-Limit: 
+      - "5000"
+      Content-Length: 
+      - "23"
+      Etag: 
+      - "\"a79261d735e1ecdd6566a15f02a46e21\""
+      X-Ratelimit-Remaining: 
+      - "4999"
+      Cache-Control: 
+      - max-age=0, private, must-revalidate
+    body: 
+      encoding: US-ASCII
+      string: <p>Hello cool world</p>
+    http_version: 
+  recorded_at: Mon, 02 Jul 2012 21:12:16 GMT
+recorded_with: VCR 2.2.0

data/features/cassettes/repos/branch.yml

@@ -0,0 +1,61 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/repos/peter-murach/github/branches/new_dsl?access_token=<TOKEN>
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      Accept-Encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept: 
+      - "*/*"
+      User-Agent: 
+      - Ruby
+  response: 
+    status: 
+      code: 200
+      message: OK
+    headers: 
+      Server: 
+      - nginx/1.0.13
+      Date: 
+      - Fri, 29 Jun 2012 20:55:08 GMT
+      Content-Type: 
+      - application/json; charset=utf-8
+      Transfer-Encoding: 
+      - chunked
+      Connection: 
+      - keep-alive
+      Status: 
+      - 200 OK
+      Cache-Control: 
+      - max-age=0, private, must-revalidate
+      X-Ratelimit-Limit: 
+      - "5000"
+      Etag: 
+      - "\"9671c6f2ca93115c89db73e8e95a228d\""
+      X-Ratelimit-Remaining: 
+      - "4999"
+      Content-Encoding: 
+      - gzip
+    body: 
+      encoding: ASCII-8BIT
+      string: !binary |
+        H4sIAAAAAAAAA+1US2/UMBD+K6tI3LqJ7TgPR0LAhRsSB24IrSb25KHdPGQ7
+        cKj2vzPuNm2KEF1aceOUicbz+Ob7Zm4jPQ1D76PqNnIdRFXUlCJtijSTwLgo
+        S6gzA8pgIzAXWok0z2tINcjoZhPqLeJjihoxb4TiGXDF0wwEN4IhpYBUFUrq
+        tDYFaFZTisWeqGbn/eyqJIG5j9ved0sdU1uJxXlyyYwe7X5YLOguuXjDJwk1
+        XXJ1rfNNNKBz0FKj0Qdjds1kB/C+H9tg7pwHfdz1YzPF1BcsvptsgGTAhwhB
+        09gzuRflF1ZWklei3LOiYowe4wB9gDFfmnzfhv+AgHwjDCH8cz95u/t0ByKi
+        Vl6B+0KYS/6aKBrjvwJEiB4nBt/Bgz08hehQLxbj1l68d/xezKSphVQmy3KS
+        XFPqDFidK2Sm4CYrlVTvzNsHgQhZxhjDEWjE8Yg+AefQu41q3oiP/UAsOzLW
+        alt7zyWL57Elbk5T24+Bt43CntPk4tA+1SRFrHUOvQkb9AweCgjvpJQpFzS5
+        GSyO3kXV13UHFcsaU+jcSFQpZLSCORfSSMWxZNBohVwbIcIOvlBIq4iurnT+
+        tu77vYz+s/xn1f7K8iuJunrbSVCHUz8eSU8kJzw1L7mvtYVRd3ReR/xxMO5E
+        YDo/bE/15kz/7kCH4/wQTC3dn8E13fknlX5IHHgGAAA=
+
+    http_version: 
+  recorded_at: Fri, 29 Jun 2012 20:55:08 GMT
+recorded_with: VCR 2.2.0

data/features/git_data/tags.feature

@@ -0,0 +1,17 @@
+Feature: Tags API
+
+  In order to interact with github git data references
+  GithubAPI gem
+  Should return the expected results depending on passed parameters
+
+  Background:
+    Given I have "Github::GitData::Tags" instance
+
+#   Scenario: Lists all tags on a repository
+#     Given I want to get resource with the following params:
+#       | user   | repo | sha |
+#       | wycats | thor | ffbc56c0c2 |
+#     When I make request within a cassette named "git_data/tags/get"
+#     Then the response status should be 200
+#       And the response type should be JSON
+#       And the response should not be empty

data/features/markdown.feature

@@ -0,0 +1,25 @@
+Feature: Markdown API
+
+  Background:
+    Given I have "Github::Markdown" instance
+
+  Scenario: Render arbitrary document
+
+    Given I want to render resource
+      And I pass the following request options:
+        | text         | mode | context               |
+        | Hello world  | gfm  | murek/github_api_test |
+    When I make request within a cassette named "markdown/render"
+    Then the response status should be 200
+      And the response type should be HTML
+      And the response should not be empty
+
+  Scenario: Render raw document text/plain
+
+    Given I want to render_raw resource with the following params:
+        | text             |
+        | Hello cool world |
+    When I make request within a cassette named "markdown/render_raw"
+    Then the response status should be 200
+      And the response type should be HTML
+      And the response should not be empty

data/features/repos.feature

@@ -13,6 +13,16 @@ Feature: Repositories API
       And the response type should be JSON
       And the response should not be empty
 
+  Scenario: Get Branch
+
+    Given I want branch resource with the following params:
+      | user          | repo   | branch  |
+      | peter-murach  | github | new_dsl |
+    When I make request within a cassette named "repos/branch"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
   Scenario: Tags
 
     Given I want tags resource with the following params:

data/features/step_definitions/common_steps.rb

@@ -23,7 +23,12 @@ Then /^the response status should be (.*)$/ do |expected_response|
 end
 
 Then /^the response type should be (.*)$/ do |type|
-  @response.content_type.should =~ /application\/#{type.downcase}/
+  case type.downcase
+  when 'json'
+    @response.content_type.should =~ /application\/json/
+  when 'html'
+    @response.content_type.should =~ /text\/html/
+  end
 end
 
 Then /^the response should have (\d+) items$/ do |size|