medium_sdk 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afab6a1385d13e4a793053d8f316d0b833965c00
-  data.tar.gz: f5103cf9ef2728c0eee21fee3ebcedac80c706c5
+  metadata.gz: f0675d736cf6cab923b2ddd7c37c0aa6f58687c5
+  data.tar.gz: 9a20441f0ccce6d749675c035a51c0660ae62608
 SHA512:
-  metadata.gz: cbc6d536ea192bdd2e1fe99dfbaaa709411b3af6363316f2c7d66c12b07724747d41cae24eb73cebcb11882d26169ea05300cd98a28a40f8ab9620c78227b830
-  data.tar.gz: fb92b3958cb66cf4a3562c270ea72ba6f4961fcb932f9cc41b437fc327e0a9c7d7a0c8af9d4d1afc0da45c9b7dfd50f29e8f82e50fb7ef1e10b1d1ab2c88c58e
+  metadata.gz: 5627bff969b90c0515545d38031b3cc9f3d25ba666571afb5d82bdad1ea0f12a14df1342f702fa6d4f7b2837cea6fe36da4789910198fc5ffe46b4a7980dbe56
+  data.tar.gz: 0e1b014755985d02b2de2609faae66af49fe605f8a9113efa81bb97b18f811e027914b3f1e396194816128132ada045a2245e21c35694d012d716872aa11a904

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 CHANGELOG
 ---------
+- **2016-08-18**: 0.0.3
+  1. Add Swagger spec
+- **2016-08-12**: 0.0.2
 - **2016-08-11**: 0.0.1
   1. Initial release
   1. Authorization via OAuth 2.0 and Integration Token

data/README.md

@@ -17,8 +17,9 @@ A Ruby SDK for the [Medium.com API](https://github.com/Medium/medium-api-docs) i
 
 1. Auth via OAuth 2.0 with [automatic token refresh](https://github.com/grokify/faraday_middleware-oauth2_refresh) and [demo app](https://github.com/grokify/medium-sdk-ruby/tree/master/scripts/sinatra). This is necessary to request the `listPublications` or `uploadImage` access scopes.
 1. Auth via integration token with [demo app](https://github.com/grokify/medium-sdk-ruby/blob/master/scripts)
-1. Get and Post convenience APIs
-1. Raw APIs via Faraday HTTP client
+1. Get and Post convenience methods
+1. Raw HTTP methods via Faraday client useful for image upload
+1. [Swagger 2.0 spec in YAML](docs/medium-api-v1-swagger.yaml) and [JSON](docs/medium-api-v1-swagger.json)
 
 ## Installation
 
@@ -96,23 +97,41 @@ client = MediumSdk.new integration_token: token
 client.connection.token = token
 ```
 
-### API Requests
+### Resource Methods
 
-#### Convenience Methods
+See the Swagger 2.0 spec in [YAML](docs/medium-api-v1-swagger.yaml) and [JSON](docs/medium-api-v1-swagger.json) for more info.
 
-Convenience methods are provided which return the `data` property of the response body.
+#### Users
+
+##### Getting the authenticated user’s details
 
 ```ruby
 # Getting the authenticated user’s details
 data = client.me
+```
+
+#### Publications
+
+##### Listing the user’s publications
 
+```ruby
 # Listing the user’s publications
 data = client.user_publications           # uses authorized user's userId
 data = client.user_publications 'user_id' # uses explicit userId
+```
+
+##### Fetching contributors for a publication
 
+```ruby
 # Fetching contributors for a publication
 data = client.publication_contributors 'publication_id'
+```
+
+#### Posts
+
+##### Creating a post
 
+```ruby
 # Creating a user post
 data = client.post, {
   title: "Hard things in software development",
@@ -132,7 +151,11 @@ data = client.post, {
   publishedAt: "2016-08-12T00:00:00+00:00",
   notifyFollowers: false
 }
+```
+
+##### Creating a post under a publication
 
+```ruby
 # Creating a publication post using `publicationId`
 data = client.post, {
   title: "Hard things in software development",
@@ -140,13 +163,25 @@ data = client.post, {
   content: "<p>Cache invalidation</p><p>Naming things</p>",
   tags: ["development", "design"],
   publishStatus: "public",
-  publicationId: "deadbeef"
+  publicationId: "b45573563f5a"
+}
+```
+
+#### Images
+
+##### Uploading an image
+
+```ruby
+# Upload image
+payload = {
+  image: Faraday::UploadIO.new('/path/to/my_image.jpg', 'image/jpeg')
 }
+response = client.connection.http.post 'images', payload
 ```
 
-#### Raw Methods
+### Raw HTTP Client
 
-The SDK's Faraday client can be accessed for sending raw requests:
+The SDK's Faraday client can be accessed for sending raw requests. This can be used to upload images using `Faraday::UploadIO`.
 
 ```ruby
 response = client.connection.http.get 'me'
@@ -156,6 +191,17 @@ response = client.connection.http do |req|
 end
 ```
 
+See the [Faraday project](https://github.com/lostisland/faraday) for more info.
+
+## Swagger Spec
+
+A Swagger 2.0 spec is included with this SDK for reference.
+
+| Format | Validation |
+|--------|------------|
+| [`JSON Spec`](docs/medium-api-v1-swagger.json) | [Validate JSON](http://online.swagger.io/validator?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgrokify%2Fmedium-sdk-ruby%2Fmaster%2Fdocs%2Fmedium-api-v1-swagger.json) |
+| [`YAML Spec`](docs/medium-api-v1-swagger.yaml) | [Validate YAML](http://online.swagger.io/validator?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgrokify%2Fmedium-sdk-ruby%2Fmaster%2Fdocs%2Fmedium-api-v1-swagger.yaml) |
+
 ## Demos
 
 Demos are in the `scripts` directory and use `.env` files for configuration.
@@ -195,6 +241,10 @@ Medium API Docs
 
 * https://github.com/Medium/medium-api-docs
 
+## Credits
+
+1. Swagger validation and YAML-to-JSON conversion by [`swagger-parser`](https://github.com/BigstickCarpet/swagger-parser).
+
 ## Contributing
 
 1. Fork it ( http://github.com/grokify/medium-sdk-ruby/fork )

data/lib/medium_sdk.rb

@@ -2,7 +2,7 @@ module MediumSdk
   autoload :Client, 'medium_sdk/client'
   autoload :Connection, 'medium_sdk/connection'
 
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 
   class << self
     def new(opts = {})

data/lib/medium_sdk/connection/auth_code.rb

@@ -57,6 +57,7 @@ module MediumSdk::Connection
 
       @http = Faraday.new(url: api_version_uri()) do |conn|
         conn.request :oauth2_refresh, @token
+        conn.request :multipart
         conn.request :json
         if @instance_headers.is_a? Hash 
           @instance_headers.each do |k,v|

data/lib/medium_sdk/connection/integration_token.rb

@@ -21,7 +21,8 @@ module MediumSdk::Connection
         'Accept-Charset' => 'utf-8'
       }
       @http  = Faraday.new(url: @endpoint, headers: headers) do |conn|
-        conn.request  :json
+        conn.request :multipart
+        conn.request :json
         conn.response :json, content_type: 'application/json'
         conn.adapter  Faraday.default_adapter
       end

data/test/test_base.rb

@@ -2,5 +2,4 @@ require 'coveralls'
 Coveralls.wear!
 
 require 'test/unit'
-#require 'mocha/test_unit'
 require 'medium_sdk'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: medium_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -112,20 +112,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -168,7 +154,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A Ruby SDK for the Medium.com API with OAuth 2 support
+description: A Ruby SDK for the Medium.com API with OAuth 2 support and Swagger spec
 email: johncwang@gmail.com
 executables: []
 extensions: []