medium_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7a60764dc7f8c9583797801ec3e2b87a05a8e7f1563f94c3c73f504e09fb720
+  data.tar.gz: 01f03c2b547b3bfd03ced8923da3e99fc9a9c94e396ddd566203418167650234
+SHA512:
+  metadata.gz: 91c4a32936c404de57b439d3326e3d9d2d31c0828a1fdfdc0906a92c3e65d9fc4598d8d38ccdc493fcbaa912b13c7125a686e62b76e41b71245e4545d8e19138
+  data.tar.gz: 6ecb7ae01aa27fdea0c98a11cb3f3a3316e0e1cacd7ceb7cb903bdcc8d7eeb45a0f0fe79525adbd8d6ba0cb777c874b74416fef0aa92f00ea7c91a260b1a22c0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in medium_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    medium_api (0.1.0)
+      httparty (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_xml (0.6.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    vcr (6.0.0)
+    webmock (3.13.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  medium_api!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,58 @@
+# MediumApi
+
+A ruby api wrapper for medium.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'medium_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install medium_api
+
+## Usage
+
+First, you need api key. To do this email yourfriends@medium.com. For more info checkout [official docs](https://github.com/Medium/medium-api-docs#22-self-issued-access-tokens)
+
+### Configure the gem
+```ruby
+MediumApi.configure do |config|
+  config.api_key = ''
+end
+```
+
+### Get current user
+```ruby
+MediumApi.me
+```
+
+### Create a post for current user
+```ruby
+MediumApi.me.create_post(post_attributes)
+```
+
+
+### Get publications for current user
+```
+MediumApi.me.publications
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thesmartnik/medium_api_udemy
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "medium_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/medium_api/client.rb

@@ -0,0 +1,79 @@
+module MediumApi
+  # A main class to make http calls to medium.com
+  class Client
+    include HTTParty
+
+    base_uri 'https://api.medium.com/v1'
+
+    attr_reader :api_key
+
+    # @visibility private
+    CODE_TO_ERROR = {
+      400 => Error::BadRequestError,
+      401 => Error::UnauthorizedError,
+      403 => Error::ForbiddenError
+    }
+
+    def initialize(api_key:)
+      @api_key = api_key
+
+      self.class.headers("Authorization" => "Bearer #{api_key}")
+    end
+
+    # Returns current user for specified api_key
+    # @return [Hash]
+    # @raise [MediumApi::Error::UnauthorizedError]
+    def me
+      with_error_handling do
+        self.class.get('/me')
+      end
+    end
+
+    # Return publications for provided user_id
+    # @param user_id [String, Integer]
+    # @return [Array<Hash>]
+    # @raise [MediumApi::Error::UnauthorizedError]
+    # @raise [MediumApi::Error::ForbiddenError]
+    def user_publications(user_id)
+      with_error_handling do
+        self.class.get("/users/#{user_id}/publications")
+      end
+    end
+
+    # Return contributors for provided publication_id
+    # @param publication_id [String, Integer]
+    # @return [Array<Hash>]
+    # @raise [MediumApi::Error::UnauthorizedError]
+    def publication_contributors(publication_id)
+      with_error_handling do
+        self.class.get("/publications/#{publication_id}/contributors")
+      end
+    end
+
+    # Creates user post for provided user_id
+    # @param user_id [String, Integer]
+    # @param post_attributes [Hash]
+    # @return [Array<Hash>]
+    # @see MediumApi::Post for possible post attributes
+    # @raise [MediumApi::Error::UnauthorizedError]
+    # @raise [MediumApi::Error::ForbiddenError]
+    # @raise [MediumApi::Error::BadRequestError]
+    def create_user_post(user_id, post_attributes)
+      with_error_handling do
+        self.class.post("/users/#{user_id}/posts", body: Utils.camelcase_keys(post_attributes))
+      end
+    end
+
+    private
+
+    def with_error_handling
+      response = yield
+
+      return response['data'] if response.success?
+
+      message = response['errors'].first['message']
+      error_class = CODE_TO_ERROR[response.code] || MediumApi::Error
+      raise error_class, message
+    end
+  end
+end

data/lib/medium_api/configuration.rb

@@ -0,0 +1,5 @@
+module MediumApi
+  class Configuration
+    attr_accessor :api_key
+  end
+end

data/lib/medium_api/contributor.rb

@@ -0,0 +1,4 @@
+module MediumApi
+  class Contributor < Struct.new(:user_id, :publication_id, :role, keyword_init: true)
+  end
+end

data/lib/medium_api/errors.rb

@@ -0,0 +1,8 @@
+module MediumApi
+  class Error < StandardError
+    UnauthorizedError = Class.new(MediumApi::Error)
+    BadRequestError = Class.new(MediumApi::Error)
+    ForbiddenError = Class.new(MediumApi::Error)
+  end
+end
+

data/lib/medium_api/post.rb

@@ -0,0 +1,4 @@
+module MediumApi
+  class Post < Struct.new(:id, :title, :author_id, :tags, :url, :canonical_url, :publish_status, :published_at, :license, :license_url, keyword_init: true)
+  end
+end

data/lib/medium_api/publication.rb

@@ -0,0 +1,13 @@
+module MediumApi
+  class Publication < Struct.new(:id, :description, :name, :url, :image_url, keyword_init: true)
+    include ResourceApi
+
+    # @return [Array<Contributor>]
+    def contributors
+      data = client.publication_contributors(id)
+      data.map do |contributor_attrs|
+        Contributor.new(Utils.underscore_keys(contributor_attrs))
+      end
+    end
+  end
+end

data/lib/medium_api/resource_api.rb

@@ -0,0 +1,7 @@
+module MediumApi::ResourceApi # @api private
+  private
+
+  def client
+    MediumApi.client
+  end
+end

data/lib/medium_api/user.rb

@@ -0,0 +1,21 @@
+module MediumApi
+  class User < Struct.new(:id, :username, :name, :url, :image_url, keyword_init: true)
+    include ResourceApi
+    # @param post_attributes
+    # @return [MediumApi::Post]
+    def create_post(post_attributes)
+      data = client.create_user_post(id, post_attributes)
+
+      Post.new(Utils.underscore_keys(data))
+    end
+
+    # @return [MediumApi::Publication]
+    def publications
+      data = client.user_publications(id)
+
+      data.map do |publication_attributes|
+        Publication.new(Utils.underscore_keys(publication_attributes))
+      end
+    end
+  end
+end

data/lib/medium_api/utils.rb

@@ -0,0 +1,30 @@
+module MediumApi
+  # @api private
+  module Utils
+    module_function
+
+    def underscore_keys(hash)
+      hash.transform_keys do |key|
+        new_key = underscore(key.to_s)
+        key.is_a?(Symbol) ? new_key.to_sym : new_key
+      end
+    end
+
+    def underscore(string)
+      string.gsub(/([A-Z])/, '_\1').downcase
+    end
+
+    def camelcase_keys(hash)
+      hash.transform_keys do |key|
+        new_key = camelcase(key.to_s)
+        key.is_a?(Symbol) ? new_key.to_sym : new_key
+      end
+    end
+
+    def camelcase(string)
+      first_word, *words = string.split('_')
+
+      [first_word, *words.map(&:capitalize)].join('')
+    end
+  end
+end

data/lib/medium_api/version.rb

@@ -0,0 +1,3 @@
+module MediumApi
+  VERSION = "1.0.0"
+end

data/lib/medium_api.rb

@@ -0,0 +1,43 @@
+require "medium_api/version"
+require 'httparty'
+require 'medium_api/utils'
+require 'medium_api/resource_api'
+require 'medium_api/errors'
+require 'medium_api/client'
+require 'medium_api/configuration'
+require 'medium_api/user'
+require 'medium_api/publication'
+require 'medium_api/post'
+require 'medium_api/contributor'
+
+module MediumApi
+  class << self
+    # Used for configuring MediumApi
+    # @example
+    #   MediumApi.configure do |config|
+    #     config.api_key = ''
+    #   end
+    # @yield [MediumApi::Configuration]
+    def configure
+      yield configuration
+    end
+
+    # @return [MediumApi::Configuration]
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Method to get current user for provided api_key
+    # @return [MediumApi::User]
+    def me
+      attributes = client.me
+
+      User.new(**Utils.underscore_keys(attributes))
+    end
+
+    # @return [MediumApi::Client]
+    def client
+      @client ||= Client.new(api_key: configuration.api_key)
+    end
+  end
+end

data/medium_api.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/medium_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "medium_api"
+  spec.version       = MediumApi::VERSION
+  spec.authors       = [" TheSmartnik"]
+  spec.email         = ["misharinn@gmail.com"]
+
+  spec.summary       = %q{Medium Api Wrapper}
+  spec.description   = %q{Gem to interact with medium.com API}
+  spec.homepage      = "https://github.com/TheSmartnik/medium_api"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty', '~> 0.20.0'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: medium_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- " TheSmartnik"
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
+  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: vcr
+  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: webmock
+  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'
+description: Gem to interact with medium.com API
+email:
+- misharinn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/medium_api.rb
+- lib/medium_api/client.rb
+- lib/medium_api/configuration.rb
+- lib/medium_api/contributor.rb
+- lib/medium_api/errors.rb
+- lib/medium_api/post.rb
+- lib/medium_api/publication.rb
+- lib/medium_api/resource_api.rb
+- lib/medium_api/user.rb
+- lib/medium_api/utils.rb
+- lib/medium_api/version.rb
+- medium_api.gemspec
+homepage: https://github.com/TheSmartnik/medium_api
+licenses: []
+metadata:
+  homepage_uri: https://github.com/TheSmartnik/medium_api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Medium Api Wrapper
+test_files: []