yandex_client 0.1.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec95accc04a86127c16f61ad3f438ec9b42c9cb5eaa03c7589191d7a4223402f
-  data.tar.gz: b1a50d5dd827ab178ec54cf6d7a6613d89e97065f5117d5669583e12678c4811
+  metadata.gz: e8b82741c31dd638b0ff6793b208d6c7ab33e9b5dc613f6c9ffd3482fb5dcde3
+  data.tar.gz: 510f836e9b6566ba397342544c9430232f7c88a39607261450d413c82b998367
 SHA512:
-  metadata.gz: 5cef57682df43d60b7f666bf7df6f77d51aeb41a96579048c0c5e84b616cdadc78f4d4efae2f0c006fa1df421179b857a312c4cac37250b5c7273c7f5a56fdd1
-  data.tar.gz: 00376bc7e7e6185bf797655630ac93509cacc567100e44f26902abfb3abd8b70e0775148ec06ff79961b8a7ea36e6be28e060b18a287acd688c7baefd1400c20
+  metadata.gz: 91e69d64b589fc868bb0bc18956cb81c85031e6f4bef8ffd8619a2578f1f5f4e269635b11d818f801230b0e7c0b491a6cd55a7a98bcab1cb6021e92d49f7f677
+  data.tar.gz: 2fff713b5cc2fe4dae297347edb3a54d4ee93c31d233d1406ad61a8d2f76ec1792c7693e5c56422b2f9a4011131c5d49454c4d9c3f44c0040d08f490298ad005

data/.github/workflows/main.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: ['*']
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: rubocop
+        run: bundle exec ./rubocop --display-style-guide --extra-details
+      - name: tests
+        run: bundle exec rspec

data/.gitignore

@@ -14,3 +14,5 @@
 .byebug_history
 
 Gemfile.lock
+.irb-save-history
+coverage

data/.pryrc

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Pry.config.history_file = "#{File.dirname(__FILE__)}/.irb-save-history"
+
+require 'bundler/setup'
+require 'yandex_client'

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'bin/**/*'
+    - '.pryrc'
+    - 'vendor/**/*'
+
+Layout/LineLength:
+  Max: 120
+
+Style/AsciiComments:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/Documentation:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/Gemfile

@@ -5,5 +5,7 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'pry-byebug'
+gem 'rubocop', require: false
+gem 'rubocop-rspec', require: false
 
 gemspec

data/README.md

@@ -1,114 +1,64 @@
-[![Build Status](https://travis-ci.org/yamax2/yandex_client.svg?branch=master)](https://travis-ci.org/yamax2/yandex_client)
-
 # YandexClient
 
 ## Installation
 
 Add this line to your application's Gemfile:
-
 ```ruby
-gem 'yandex_client'
+gem 'yandex_client', '>= 1'
 ```
 
 And then execute:
-
-    $ bundle
+```bash
+$ bundle install
+```
 
 Or install it yourself as:
-
-    $ gem install yandex_client
-
-## Usage
-
-### [Auth](https://yandex.ru/dev/oauth/doc/dg/concepts/about-docpage/)
-```ruby
-cli = YandexClient::Auth::Client.new
+```bash
+$ gem install yandex_client
 ```
 
-[create_token](https://tech.yandex.ru/oauth/doc/dg/reference/auto-code-client-docpage/#auto-code-client__get-token)
-```ruby
-cli.create_token(code: 'your_code')
-```
+## Disk webdav
 
-[refresh_token](https://yandex.ru/dev/oauth/doc/dg/reference/refresh-client-docpage/)
-```ruby
-cli.refresh_token(refresh_token: 'your_token')
-```
+https://tech.yandex.ru/disk/doc/dg/reference/put-docpage/
 
-### [Passport](https://tech.yandex.ru/passport/doc/dg/reference/)
+Chainable client:
 ```ruby
-cli = YandexClient::Passport::Client.new(access_token: 'your_access_token')
+YandexClient::Dav['your_access_token']
+    .put('1.txt', '/a/b/c/1.txt')
+    .put(File.open('1.txt', 'rb'), '/path/to/1.txt')
+    .put(Tempfile.new.tap { |t| t.write('say ni'); t.rewind }, '/path/to/tmp.txt')
+    .delete('/a/b/c/1.txt')
+    .mkcol('/a/b/c')
+    .propfind('/a/dip.yml', depth: 0)
+    .propfind('/a', depth: 1)
+    .propfind.to_a
 ```
 
-[info](https://yandex.ru/dev/passport/doc/dg/reference/request-docpage/)
-```ruby
-cli.info
-```
+## Disk rest api
 
-### [Yandex Disk WebDav](https://yandex.ru/dev/disk/doc/dg/concepts/quickstart-docpage/)
-```ruby
-cli = YandexClient::Dav::Client.new(access_token: 'your_token')
-```
+https://yandex.ru/dev/disk/api/reference/capacity-docpage/
+https://yandex.ru/dev/disk/api/reference/content-docpage/
 
-[put](https://yandex.ru/dev/disk/doc/dg/reference/put-docpage/)
 ```ruby
-cli.put(file: '1.txt', name: '/a/b/c/1.txt')
+YandexClient::Disk['access_token'].info
+YandexClient::Disk['access_token'].download_url('path/to/file')
+YandexClient::Disk['access_token'].upload_url('path/to/file')
 ```
 
-[delete](https://yandex.ru/dev/disk/doc/dg/reference/delete-docpage/)
-```ruby
-cli.delete(name: '/a/b/c/1.txt')
-```
+## Auth
 
-[mkcol](https://yandex.ru/dev/disk/doc/dg/reference/mkcol-docpage/)
-```ruby
-cli.mkcol(name: '/a/b/c')
-```
-
-[file props](https://yandex.ru/dev/disk/doc/dg/reference/property-request-docpage/)
-```ruby
-cli.propfind(name: '/a/dip.yml', depth: 0)
-```
+https://tech.yandex.ru/oauth/doc/dg/reference/refresh-client-docpage/
+https://tech.yandex.ru/oauth/doc/dg/reference/auto-code-client-docpage/#auto-code-client__get-token
 
-[list files in dir](https://yandex.ru/dev/disk/doc/dg/reference/property-request-docpage/)
 ```ruby
-cli.propfind(name: '/a', depth: 1)
+YandexClient.auth.create_token('9388894')
+YandexClient.auth.refresh_token('refresh_token')
 ```
 
-[account free space and quota](https://yandex.ru/dev/disk/doc/dg/reference/property-request-docpage/)
-```ruby
-cli.propfind(name: '/', quota: true)
-```
-
-## 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).
+## Passport
 
-## Development with docker
+https://tech.yandex.ru/passport/doc/dg/reference/request-docpage/
 
-* Install docker and docker-compose
-* Install [dip](https://github.com/bibendi/dip)
-```hash
-gem install dip
-``` 
-* Prepare the the test environment
-```bash
-dip provision
-```
-* Run tests
-```bash
-dip rspec
+```ruby
+YandexClient::Passport::Client['access_token'].info
 ```
-
-## TODO
-* docs...
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/yamax2/yandex_client.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/dip.yml

@@ -1,14 +1,11 @@
-version: '1'
+version: '3.3'
 
 environment:
-  DOCKER_RUBY_VERSION: 2.6
-  RUBY_IMAGE_TAG: 2.6.5
-  COMPOSE_FILE_EXT: development
+  DOCKER_RUBY_VERSION: 3.0
 
 compose:
   files:
     - docker/docker-compose.yml
-    - docker/docker-compose.${COMPOSE_FILE_EXT}.yml
   project_name: yandex_client
 
 interaction:
@@ -17,7 +14,7 @@ interaction:
 
   irb:
     service: app
-    command: irb
+    command: bundle exec pry
 
   bundle:
     service: app
@@ -31,12 +28,16 @@ interaction:
     service: app
     command: bundle exec rspec
 
+  rubocop:
+    service: app
+    command: bundle exec ./rubocop --display-style-guide --extra-details
+
   clean:
     service: app
-    command: rm -f Gemfile.lock
+    command: rm -rf Gemfile.lock
 
 provision:
+  - ./docker/prepare_env.sh
   - docker volume create --name bundler_data
   - dip clean
   - dip bundle install
-  - dip appraisal install

data/docker/Dockerfile.dip

@@ -0,0 +1,8 @@
+ARG DOCKER_RUBY_VERSION
+FROM ruby:${DOCKER_RUBY_VERSION}-alpine
+
+RUN gem update --system && \
+    apk add --update --no-cache tzdata less git build-base mc && \
+    cp /usr/share/zoneinfo/Asia/Yekaterinburg /etc/localtime && echo 'Asia/Yekaterinburg' > /etc/timezone
+
+WORKDIR /app

data/docker/docker-compose.yml

@@ -1,14 +1,22 @@
-version: '2'
+version: '3.3'
 
 services:
   app:
     build:
       context: ../
-      dockerfile: ./docker/Dockerfile.${DOCKER_RUBY_VERSION}
+      dockerfile: ./docker/Dockerfile.dip
+      args:
+        DOCKER_RUBY_VERSION: $DOCKER_RUBY_VERSION
+      labels:
+        com.yandex-client.ruby.version: $DOCKER_RUBY_VERSION
     environment:
-      - BUNDLE_PATH=/bundle/$DOCKER_RUBY_VERSION
-      - SSH_AUTH_SOCK=/ssh/auth/sock
-      - TEST_DB_HOST=db
-      - TEST_DB_NAME=docker
-      - TEST_DB_USERNAME=postgres
-    command: bash
+      - BUNDLE_PATH=/bundle/${DOCKER_RUBY_VERSION}
+    volumes:
+      - ..:/app
+      - bundler-data:/bundle
+    command: sh
+
+volumes:
+  bundler-data:
+    external:
+      name: bundler_data

data/docker/prepare_env.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+set -e
+
+for line in $(docker images -f "label=com.yandex-client.ruby.version" -q | uniq); do
+  ver=$(docker inspect --format '{{ index .Config.Labels "com.yandex-client.ruby.version"}}' $line)
+
+  if ! [ $ver = $DOCKER_RUBY_VERSION ]; then
+    docker image rm --force $line
+  fi
+done

data/lib/yandex_client/auth.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module YandexClient
+  # https://tech.yandex.ru/oauth/doc/dg/reference/refresh-client-docpage/
+  # https://tech.yandex.ru/oauth/doc/dg/reference/auto-code-client-docpage/#auto-code-client__get-token
+  #
+  # https://oauth.yandex.ru/authorize?response_type=code&client_id=ede5c51271164a9e833ab9119b4d3c26&force_confirm=false
+  #
+  # Example:
+  #   token = Token.first
+  #
+  #   YandexClient.auth.create_token('9388894')
+  #   YandexClient.auth.refresh_token(token.refresh_token)
+  class Auth
+    include Configurable
+    include ErrorHandler
+
+    ACTION_URL = 'https://oauth.yandex.ru/token'
+
+    def create_token(code)
+      process_response with_config.post(
+        ACTION_URL,
+        headers: common_headers,
+        body: URI.encode_www_form(
+          request_body_for('authorization_code').merge!(code: code)
+        )
+      )
+    end
+
+    def refresh_token(refresh_token)
+      process_response with_config.post(
+        ACTION_URL,
+        headers: common_headers,
+        body: URI.encode_www_form(
+          request_body_for('refresh_token').merge!(refresh_token: refresh_token)
+        )
+      )
+    end
+
+    private
+
+    def common_headers
+      {'Content-type' => 'application/x-www-form-urlencoded'}
+    end
+
+    def request_body_for(grant_type)
+      {
+        grant_type: grant_type,
+        client_id: config.api_key,
+        client_secret: config.api_secret
+      }
+    end
+
+    def process_response(response)
+      if response.status.success?
+        JSON.parse(response.body, symbolize_names: true)
+      else
+        error_for_response(response)
+      end
+    end
+  end
+end

data/lib/yandex_client/configurable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module YandexClient
+  module Configurable
+    def self.included(base)
+      base.extend Forwardable
+      base.def_delegator :YandexClient, :config
+    end
+
+    private
+
+    def with_config
+      req = HTTP.timeout(
+        connect: config.connect_timeout,
+        read: config.read_timeout,
+        write: config.write_timeout
+      )
+
+      if config.logger
+        req.use(logging: {logger: config.logger})
+      else
+        req
+      end
+    end
+  end
+end

data/lib/yandex_client/dav/prop_find_response.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'ox'
+require 'cgi'
+
+module YandexClient
+  class Dav
+    class PropFindResponse
+      include Enumerable
+
+      SUCCESS_STATUS = 'HTTP/1.1 200 OK'
+
+      class Item
+        attr_reader :name, :created_at, :last_modified, :content_type
+
+        def initialize(name, node)
+          @name = name
+          @folder = node[:'d:resourcetype'].is_a?(Hash)
+
+          load_node_data(node)
+        end
+
+        def folder?
+          @folder
+        end
+
+        def file?
+          !@folder
+        end
+
+        private
+
+        def load_node_data(node)
+          @created_at = node.fetch(:'d:creationdate')
+          @last_modified = node.fetch(:'d:getlastmodified')
+
+          return if folder?
+
+          @etag = node.fetch(:'d:getetag')
+          @size = node.fetch(:'d:getcontentlength').to_i
+          @content_type = node.fetch(:'d:getcontenttype')
+
+          define_singleton_method(:etag) { @etag }
+          define_singleton_method(:size) { @size }
+          define_singleton_method(:content_type) { @content_type }
+        end
+      end
+
+      def initialize(xml)
+        @doc = Ox.load(
+          xml.dup.force_encoding('UTF-8'),
+          mode: :hash
+        )
+      end
+
+      def each
+        @doc[:'d:multistatus'].each do |node|
+          next if (response = node[:'d:response']).nil?
+
+          name = CGI.unescape(response.fetch(:'d:href'))
+          node_data = response.fetch(:'d:propstat')
+
+          raise ParseError unless node_data.fetch(:'d:status') == SUCCESS_STATUS
+
+          yield Item.new(name, node_data.fetch(:'d:prop'))
+        end
+      end
+    end
+  end
+end

data/lib/yandex_client/dav.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'digest'
+require 'http'
+require 'yandex_client/dav/prop_find_response'
+
+module YandexClient
+  # https://tech.yandex.ru/disk/doc/dg/reference/put-docpage/
+  #
+  # Chainable client:
+  #
+  # YandexClient::Dav[access_token]
+  #   .put('1.txt', '/a/b/c/1.txt')
+  #   .put(File.open('1.txt', 'rb'), '/path/to/1.txt')
+  #   .put(Tempfile.new.tap { |t| t.write('say ni'); t.rewind }, '/path/to/tmp.txt')
+  #   .delete('/a/b/c/1.txt')
+  #   .mkcol('/a/b/c')
+  #   .propfind('/a/dip.yml', depth: 0)
+  #   .propfind('/a', depth: 1)
+  #   .propfind.to_a
+  class Dav
+    include Configurable
+    include ErrorHandler
+
+    ACTION_URL = 'https://webdav.yandex.ru'
+    PROPFIND_QUERY = '<?xml version="1.0" encoding="utf-8"?><propfind xmlns="DAV:"></propfind>'
+
+    attr_reader :token
+
+    class << self
+      def with_token(token)
+        new(token)
+      end
+
+      alias [] with_token
+    end
+
+    def initialize(token)
+      @token = token
+    end
+
+    def put(file, dest, etag: nil, sha256: nil, size: nil)
+      io = file.is_a?(String) ? File.open(file, 'rb') : file
+
+      headers = auth_headers.merge!(
+        'Etag' => etag || Digest::MD5.file(io.path),
+        'Sha256' => sha256 || Digest::SHA256.file(io.path),
+        'Expect' => '100-continue',
+        'Content-Length' => (size || File.size(io.path)).to_s
+      )
+
+      process_response with_config.put(url_for(dest), body: io, headers: headers)
+    end
+
+    def delete(dest)
+      process_response with_config.delete(
+        url_for(dest),
+        headers: auth_headers
+      )
+    end
+
+    def mkcol(dest)
+      process_response with_config.request(
+        :mkcol,
+        url_for(dest),
+        headers: auth_headers
+      )
+    end
+
+    def propfind(dest = '', depth = 1)
+      headers = auth_headers.merge!(
+        Depth: depth.to_s,
+        'Content-Type' => 'application/x-www-form-urlencoded',
+        'Content-Length' => PROPFIND_QUERY.length
+      )
+
+      response = with_config.request(:propfind, url_for(dest), headers: headers, body: PROPFIND_QUERY)
+      process_response(response)
+
+      PropFindResponse.new(response.body.to_s)
+    end
+
+    private
+
+    def auth_headers
+      {Authorization: "OAuth #{token}"}
+    end
+
+    def url_for(dest)
+      URI.parse(ACTION_URL).tap do |uri|
+        path = dest
+        path = "/#{path}" unless path.match?(%r{^/})
+
+        uri.path = path
+      end
+    end
+
+    def process_response(response)
+      return self if response.status.success?
+
+      error_for_response(response)
+    end
+  end
+end

data/lib/yandex_client/disk.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module YandexClient
+  # https://yandex.ru/dev/disk/api/reference/capacity-docpage/
+  # https://yandex.ru/dev/disk/api/reference/content-docpage/
+  #
+  # YandexClient::Disk[access_token].info
+  # YandexClient::Disk[access_token].download_url('path/to/file')
+  # YandexClient::Disk[access_token].download_url('path/to/file', overwrite: false)
+  class Disk
+    include Configurable
+    include ErrorHandler
+
+    ACTION_URL = 'https://cloud-api.yandex.net'
+
+    attr_reader :token
+
+    class << self
+      def with_token(token)
+        new(token)
+      end
+
+      alias [] with_token
+    end
+
+    def initialize(token)
+      @token = token
+    end
+
+    def info
+      process_response(
+        with_config.get("#{ACTION_URL}/v1/disk/", headers: auth_headers)
+      )
+    end
+
+    def download_url(path)
+      url = URI.parse(ACTION_URL).tap do |uri|
+        uri.path = '/v1/disk/resources/download'
+        uri.query = URI.encode_www_form(path: path)
+      end
+
+      process_response(
+        with_config.get(url, headers: auth_headers)
+      ).fetch(:href)
+    end
+
+    def upload_url(path, overwrite: false)
+      url = URI.parse(ACTION_URL).tap do |uri|
+        uri.path = '/v1/disk/resources/upload'
+        uri.query = URI.encode_www_form(path: ::CGI.escape(path), overwrite: overwrite)
+      end
+
+      process_response(
+        with_config.get(url, headers: auth_headers)
+      ).fetch(:href)
+    end
+
+    private
+
+    def auth_headers
+      {Authorization: "OAuth #{@token}"}
+    end
+
+    def process_response(response)
+      return JSON.parse(response.body, symbolize_names: true) if response.status.success?
+
+      error_for_response(response)
+    end
+  end
+end