medium-sdk-ruby 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.codeclimate.yml +47 -0
- data/.gitignore +9 -0
- data/.travis.yml +25 -0
- data/.yardopts +2 -0
- data/Gemfile +4 -0
- data/LICENSE +202 -0
- data/README.md +49 -0
- data/Rakefile +11 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/lib/medium.rb +10 -0
- data/lib/medium/client.rb +69 -0
- data/lib/medium/posts.rb +60 -0
- data/lib/medium/users.rb +36 -0
- data/lib/medium/version.rb +4 -0
- data/medium.gemspec +30 -0
- metadata +143 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 9666da6906cd2e43cc0bbe9211d239760b2c0607
|
4
|
+
data.tar.gz: d77d8fe782af0665066c64dfce45f4ac5231014e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ce210ec0851892e877404a071ced360c36c8ae9378fd1a475dfd5cdd7c497ba4ceeea49eec4c1f87212038a236ac468b94e02898cd31ac46563c12d19106bff9
|
7
|
+
data.tar.gz: 9fcba9fdd39830deef1d3f8122c4b38ef1bdc461e5bed98a0263378d14157b23f5e4e665832832f01c6a0249c9f6574b3d0b76ed7e5bf431839ee2a79b66fc2b
|
data/.codeclimate.yml
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# This is a sample .codeclimate.yml configured for Engine analysis on Code
|
2
|
+
# Climate Platform. For an overview of the Code Climate Platform, see here:
|
3
|
+
# http://docs.codeclimate.com/article/300-the-codeclimate-platform
|
4
|
+
|
5
|
+
# Under the engines key, you can configure which engines will analyze your repo.
|
6
|
+
# Each key is an engine name. For each value, you need to specify enabled: true
|
7
|
+
# to enable the engine as well as any other engines-specific configuration.
|
8
|
+
|
9
|
+
# For more details, see here:
|
10
|
+
# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
|
11
|
+
|
12
|
+
# For a list of all available engines, see here:
|
13
|
+
# http://docs.codeclimate.com/article/296-engines-available-engines
|
14
|
+
|
15
|
+
# languages:
|
16
|
+
# Ruby: true
|
17
|
+
|
18
|
+
engines:
|
19
|
+
rubocop:
|
20
|
+
enabled: true
|
21
|
+
flay:
|
22
|
+
enabled: true
|
23
|
+
bundler-audit:
|
24
|
+
enabled: true
|
25
|
+
|
26
|
+
# Engines can analyze files and report issues on them, but you can separately
|
27
|
+
# decide which files will receive ratings based on those issues. This is
|
28
|
+
# specified by path patterns under the ratings key.
|
29
|
+
|
30
|
+
# For more details see here:
|
31
|
+
# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
|
32
|
+
|
33
|
+
ratings:
|
34
|
+
paths:
|
35
|
+
- bin/**
|
36
|
+
- lib/**
|
37
|
+
- test/**
|
38
|
+
- Rakefile
|
39
|
+
- medium.gemspec
|
40
|
+
- Gemfile
|
41
|
+
|
42
|
+
# You can globally exclude files from being analyzed by any engine using the
|
43
|
+
# exclude_paths key.
|
44
|
+
|
45
|
+
#exclude_paths:
|
46
|
+
#- spec/**/*
|
47
|
+
#- vendor/**/*
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
language: ruby
|
2
|
+
sudo: false
|
3
|
+
cache: bundler
|
4
|
+
rvm:
|
5
|
+
- 2.0.0
|
6
|
+
- 2.1.0
|
7
|
+
- 2.1.5
|
8
|
+
- 2.2.0
|
9
|
+
- 2.2.1
|
10
|
+
- 2.2.2
|
11
|
+
- 2.2.3
|
12
|
+
- rbx-2
|
13
|
+
- ruby-head
|
14
|
+
- jruby-head
|
15
|
+
|
16
|
+
before_install:
|
17
|
+
- gem install bundler -v 1.10.6
|
18
|
+
- gem update --system
|
19
|
+
- gem --version
|
20
|
+
|
21
|
+
gemfile:
|
22
|
+
- Gemfile
|
23
|
+
|
24
|
+
notifications:
|
25
|
+
email: false
|
data/.yardopts
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
202
|
+
|
data/README.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
[![Build Status](https://travis-ci.org/kkirsche/medium-sdk-ruby.svg)](https://travis-ci.org/kkirsche/medium-sdk-ruby) [![Code Climate](https://codeclimate.com/github/kkirsche/medium-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/kkirsche/medium-sdk-ruby) [![Test Coverage](https://codeclimate.com/github/kkirsche/medium-sdk-ruby/badges/coverage.svg)](https://codeclimate.com/github/kkirsche/medium-sdk-ruby/coverage)
|
2
|
+
|
3
|
+
# Medium SDK for Ruby
|
4
|
+
|
5
|
+
This repository contains the open source SDK for integrating Medium's API into your Ruby app.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'medium'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install medium
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
Create a client, then call commands on it.
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'medium'
|
29
|
+
|
30
|
+
# If you have a self-issued access token, you can create a new client directly:
|
31
|
+
client = Medium::Client.new integration_token: 'example_token'
|
32
|
+
|
33
|
+
# Get profile details of the user identified by the access token.
|
34
|
+
client.user.me
|
35
|
+
```
|
36
|
+
|
37
|
+
## Development
|
38
|
+
|
39
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
40
|
+
|
41
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
42
|
+
|
43
|
+
## Contributing
|
44
|
+
|
45
|
+
Questions, comments, bug reports, and pull requests are all welcomed on Github at https://github.com/kkirsche/medium-sdk-ruby.
|
46
|
+
|
47
|
+
## Authors
|
48
|
+
|
49
|
+
* [Kevin Kirsche](https://github.com/kkirsche)
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "medium"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/lib/medium.rb
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
# Medium is a module used to interact with the Medium v1 API
|
2
|
+
module Medium
|
3
|
+
# The Client class is used to interact with the resources the Medium API
|
4
|
+
# exposes.
|
5
|
+
class Client
|
6
|
+
# :users is the User resource sub-client
|
7
|
+
# :posts is the Post resource sub-client
|
8
|
+
attr_reader :users, :posts
|
9
|
+
|
10
|
+
# Creates a new instance of Medium::Client.
|
11
|
+
#
|
12
|
+
# @param auth_creds [Hash] The credentials to use for authentication with
|
13
|
+
# the Medium API. This can be a self provided :integration_token. OAuth
|
14
|
+
# support to be added in the future.
|
15
|
+
def initialize(auth_creds)
|
16
|
+
@client = Hurley::Client.new 'https://api.medium.com/v1/'
|
17
|
+
@client.connection = Hurley::HttpCache.new
|
18
|
+
auth_headers_with auth_creds
|
19
|
+
|
20
|
+
true
|
21
|
+
end
|
22
|
+
|
23
|
+
# Create a user resource sub-client if necessary.
|
24
|
+
#
|
25
|
+
# @return [Medium::Users] Medium Users resource sub-client
|
26
|
+
def users
|
27
|
+
@users ||= Medium::Users.new @client
|
28
|
+
end
|
29
|
+
|
30
|
+
# Create a posts resource sub-client if necessary.
|
31
|
+
#
|
32
|
+
# @return [Medium::Users] Medium Users resource sub-client
|
33
|
+
def posts
|
34
|
+
@posts ||= Medium::Posts.new @client
|
35
|
+
end
|
36
|
+
|
37
|
+
private
|
38
|
+
|
39
|
+
# Add authorization headers to the Hurley client. This allows us to
|
40
|
+
# authenticate and communicate with the Medium API.
|
41
|
+
#
|
42
|
+
# @param creds [Hash] The credentials / key to use when authenticating with
|
43
|
+
# the Medium API.
|
44
|
+
# @return [TrueClass] Returns true if the headers are set successfully.
|
45
|
+
# Otherwise, an error is thrown.
|
46
|
+
def auth_headers_with(creds)
|
47
|
+
token = creds[:integration_token] || creds['integration_token']
|
48
|
+
@client.header[:Authorization] = "Bearer #{token}"
|
49
|
+
true
|
50
|
+
end
|
51
|
+
|
52
|
+
# A class method to validate responses from the Medium API.
|
53
|
+
#
|
54
|
+
# @param response [#status_type and #body] The response object from the
|
55
|
+
# remote server. The body is the actual response from the server. The
|
56
|
+
# status_type exposes whether the request was successful or if it failed
|
57
|
+
# with an error
|
58
|
+
# @return [Hash] Returns the response body if the request is successful.
|
59
|
+
# Otherwise, an error is thrown.
|
60
|
+
def self.validate(response)
|
61
|
+
response_body = JSON.parse response.body
|
62
|
+
if response.success?
|
63
|
+
response_body
|
64
|
+
else
|
65
|
+
fail "Failed with #{response.status_type} error from server. Received error: #{response_body['errors'][0]['message']}"
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
data/lib/medium/posts.rb
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
module Medium
|
2
|
+
class Posts
|
3
|
+
def initialize(client)
|
4
|
+
@client = client
|
5
|
+
end
|
6
|
+
|
7
|
+
# Creates a post on the authenticated user’s profile.
|
8
|
+
#
|
9
|
+
# @param opts [Hash] A hash of options to use when creating a post. The opts
|
10
|
+
# hash requires the keys: `:title`, `:content_format`, and `:content`. The
|
11
|
+
# following keys are optional: `:tags`, `:canonical_url`,
|
12
|
+
# `:publish_status`, and `:license`
|
13
|
+
# @return [Hash] The response is a Post object within a data envelope.
|
14
|
+
# Example response:
|
15
|
+
# ```
|
16
|
+
# HTTP/1.1 201 OK
|
17
|
+
# Content-Type: application/json; charset=utf-8
|
18
|
+
# {
|
19
|
+
# "data": {
|
20
|
+
# "id": "e6f36a",
|
21
|
+
# "title": "Liverpool FC",
|
22
|
+
# "authorId": "5303d74c64f66366f00cb9b2a94f3251bf5",
|
23
|
+
# "tags": ["football", "sport", "Liverpool"],
|
24
|
+
# "url": "https://medium.com/@majelbstoat/liverpool-fc-e6f36a",
|
25
|
+
# "canonicalUrl": "http://jamietalbot.com/posts/liverpool-fc",
|
26
|
+
# "publishStatus": "public",
|
27
|
+
# "publishedAt": 1442286338435,
|
28
|
+
# "license": "all-rights-reserved",
|
29
|
+
# "licenseUrl": "https://medium.com/policy/9db0094a1e0f"
|
30
|
+
# }
|
31
|
+
# }
|
32
|
+
# ```
|
33
|
+
def create(opts)
|
34
|
+
@client.post "users/#{@client.users.me['data']['id']}/posts",
|
35
|
+
build_request_with(opts)
|
36
|
+
end
|
37
|
+
|
38
|
+
private
|
39
|
+
|
40
|
+
# Takes the options provided in `Medium::Posts#create` and buildes the
|
41
|
+
# appropriate hash of options from it.
|
42
|
+
#
|
43
|
+
# @param opts [Hash] A hash of options to use when creating a post. The opts
|
44
|
+
# hash requires the keys: `:title`, `:content_format`, and `:content`. The
|
45
|
+
# following keys are optional: `:tags`, `:canonical_url`,
|
46
|
+
# `:publish_status`, and `:license`
|
47
|
+
# @return [Hash] The request hash
|
48
|
+
def build_request_with(opts)
|
49
|
+
{}.tap do |hash|
|
50
|
+
hash[:title] = opts[:title]
|
51
|
+
hash[:contentFormat] = opts[:content_format]
|
52
|
+
hash[:content] = opts[:content]
|
53
|
+
hash[:tags] = opts[:tags] if opts.key? :tags
|
54
|
+
hash[:canonicalUrl] = opts[:canonical_url] if opts.key? :canonical_url
|
55
|
+
hash[:publishStatus] = opts[:publish_status] if opts.key? :publish_status
|
56
|
+
hash[:license] = opts[:license] if opts.key? :license
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
data/lib/medium/users.rb
ADDED
@@ -0,0 +1,36 @@
|
|
1
|
+
# Medium is a module used to interact with the Medium v1 API
|
2
|
+
module Medium
|
3
|
+
# Users class is used to interact with the Users API endpoint of Medium
|
4
|
+
class Users
|
5
|
+
# Initialize a new Medium::Users client
|
6
|
+
#
|
7
|
+
# @param client [#get] The network client to use while retrieving data from
|
8
|
+
# the Users resource.
|
9
|
+
# @return [Medium::Users] Returns a Medium::Users instance
|
10
|
+
def initialize(client)
|
11
|
+
@client = client
|
12
|
+
end
|
13
|
+
|
14
|
+
# Returns details of the user who has granted permission to the application.
|
15
|
+
#
|
16
|
+
# @return [Hash] The response is a User object within a data envelope.
|
17
|
+
# Example response:
|
18
|
+
# ```
|
19
|
+
# HTTP/1.1 200 OK
|
20
|
+
# Content-Type: application/json; charset=utf-8
|
21
|
+
# {
|
22
|
+
# "data": {
|
23
|
+
# "id": "123456789exampleid",
|
24
|
+
# "username": "kkirsche",
|
25
|
+
# "name": "Kevin Kirsche",
|
26
|
+
# "url": "https://medium.com/@kkirsche",
|
27
|
+
# "imageUrl": "https://images.medium.com/somewhere.png"
|
28
|
+
# }
|
29
|
+
# }
|
30
|
+
# ```
|
31
|
+
def me
|
32
|
+
response = @client.get 'me'
|
33
|
+
Medium::Client.validate response
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
data/medium.gemspec
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'medium/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'medium-sdk-ruby'
|
8
|
+
spec.version = Medium::VERSION
|
9
|
+
spec.authors = ['Kevin Kirsche']
|
10
|
+
spec.email = ['kev.kirsche@gmail.com']
|
11
|
+
|
12
|
+
spec.summary = 'Ruby SDK for interacting with the Medium API'
|
13
|
+
spec.description = 'Ruby SDK for interacting with the Medium API'
|
14
|
+
spec.homepage = 'https://github.com/kkirsche/medium-sdk-ruby'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = 'exe'
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.required_ruby_version = '>= 2.0.0'
|
22
|
+
|
23
|
+
spec.add_runtime_dependency 'hurley', '~> 0.0'
|
24
|
+
spec.add_runtime_dependency 'hurley-http-cache', '~> 0.1'
|
25
|
+
|
26
|
+
spec.add_development_dependency 'bundler', '~> 1.10'
|
27
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
28
|
+
spec.add_development_dependency 'minitest', '~> 5.8'
|
29
|
+
spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
|
30
|
+
end
|
metadata
ADDED
@@ -0,0 +1,143 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: medium-sdk-ruby
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kevin Kirsche
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-10-09 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: hurley
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: hurley-http-cache
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0.1'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0.1'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.10'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.10'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: minitest
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '5.8'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '5.8'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: codeclimate-test-reporter
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0.4'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0.4'
|
97
|
+
description: Ruby SDK for interacting with the Medium API
|
98
|
+
email:
|
99
|
+
- kev.kirsche@gmail.com
|
100
|
+
executables: []
|
101
|
+
extensions: []
|
102
|
+
extra_rdoc_files: []
|
103
|
+
files:
|
104
|
+
- ".codeclimate.yml"
|
105
|
+
- ".gitignore"
|
106
|
+
- ".travis.yml"
|
107
|
+
- ".yardopts"
|
108
|
+
- Gemfile
|
109
|
+
- LICENSE
|
110
|
+
- README.md
|
111
|
+
- Rakefile
|
112
|
+
- bin/console
|
113
|
+
- bin/setup
|
114
|
+
- lib/medium.rb
|
115
|
+
- lib/medium/client.rb
|
116
|
+
- lib/medium/posts.rb
|
117
|
+
- lib/medium/users.rb
|
118
|
+
- lib/medium/version.rb
|
119
|
+
- medium.gemspec
|
120
|
+
homepage: https://github.com/kkirsche/medium-sdk-ruby
|
121
|
+
licenses: []
|
122
|
+
metadata: {}
|
123
|
+
post_install_message:
|
124
|
+
rdoc_options: []
|
125
|
+
require_paths:
|
126
|
+
- lib
|
127
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 2.0.0
|
132
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
133
|
+
requirements:
|
134
|
+
- - ">="
|
135
|
+
- !ruby/object:Gem::Version
|
136
|
+
version: '0'
|
137
|
+
requirements: []
|
138
|
+
rubyforge_project:
|
139
|
+
rubygems_version: 2.4.5.1
|
140
|
+
signing_key:
|
141
|
+
specification_version: 4
|
142
|
+
summary: Ruby SDK for interacting with the Medium API
|
143
|
+
test_files: []
|