yadisk-client 1.10.2

data/lib/yadisk/resources/trash.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Yadisk
+  class TrashRest < Rest
+    def delete(path:, **params)
+      path = Addressable::URI.parse(path).normalize
+      Link.new delete_request("disk/trash/resources?path=#{path}", params: params).body
+    end
+
+    def list(path:, **params)
+      path = Addressable::URI.parse(path).normalize
+      TrashResource.new get_request("disk/trash/resources?path=#{path}", params: params).body
+    end
+
+    def restore(path:)
+      path = Addressable::URI.parse(path).normalize
+      Link.new put_request("disk/trash/resources/restore?path=#{path}", body: "").body
+    end
+  end
+end

data/lib/yadisk/rest.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Yadisk
+  class Rest
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/AbcSize
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body['error']}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body['error']}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body['error']}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body['error']}"
+      when 429
+        raise Error, "Your request exceeded the API rate limit. #{response.body['error']}"
+      when 500
+        raise Error, "We were unable to perform the request due to server-side problems. #{response.body['error']}"
+      when 503
+        raise Error, "You have been rate limited for sending more  requests per second. #{response.body['error']}"
+      end
+
+      response
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/yadisk/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Yadisk
+  major = 1  # supported API version
+  minor = 10 # gem release version
+  patch = 2
+
+  VERSION = "#{major}.#{minor}.#{patch}"
+end

data/lib/yadisk.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "addressable/uri"
+require "faraday"
+require "faraday_middleware"
+require "yadisk/version"
+
+module Yadisk
+  autoload :Client, "yadisk/client"
+  autoload :Object, "yadisk/object"
+  autoload :Error,  "yadisk/error"
+  autoload :Rest,   "yadisk/rest"
+
+  autoload :Collection, "yadisk/collection"
+
+  autoload :Operation, "yadisk/objects/operation"
+  autoload :OperationRest, "yadisk/resources/operation"
+
+  autoload :PublicRest, "yadisk/resources/public"
+  autoload :PublicResource, "yadisk/objects/public"
+
+  autoload :Trash, "yadisk/objects/trash"
+  autoload :TrashResource, "yadisk/objects/trash"
+  autoload :TrashRest, "yadisk/resources/trash"
+
+  autoload :Disk, "yadisk/objects/disk"
+  autoload :DiskRest, "yadisk/resources/disk"
+
+  autoload :Link, "yadisk/objects/link"
+  autoload :Resource, "yadisk/objects/resource"
+  autoload :ResourceUploadLink, "yadisk/objects/resource"
+  autoload :LastUploadedResourceList, "yadisk/objects/resource"
+
+  autoload :Operation, "yadisk/objects/operation"
+end

data/spec/lib/yadisk/client_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Yadisk::Client do
+  context "client with token: test" do
+    it "returns correct instance of Yadisk::Client" do
+      expect(@yandex).to be_kind_of(Yadisk::Client)
+    end
+  end
+
+  context "client without token" do
+    let(:client) { Yadisk::Client.new }
+    it "returns nil" do
+      expect { client }.to raise_error(ArgumentError)
+        .with_message("missing keyword: token")
+    end
+  end
+end

data/spec/lib/yadisk/disk_spec.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+# e2e vars
+# test_file_path = "spec/test_data/test_file.txt"
+test_file_name = "remote_file.txt"
+test_upload_link = ""
+
+# rubocop:disable Metrics/BlockLength
+describe Yadisk::Client do
+  # TODO: refactor by separating test cases - HOW TO DO THIS ?
+  # TODO: describe > context > it
+  context "#disk" do
+    it "#info", :vcr do
+      name = "disk/GET_info"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.info
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::Disk)
+      end
+    end
+
+    it "#upload", :vcr do
+      name = "disk/GET_upload"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.upload(path: test_file_name)
+        test_upload_link = resp.href
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/upload?path=remote_file.txt")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::ResourceUploadLink)
+      end
+    end
+
+    # it "#upload_from_file", :vcr do
+    #   name = "disk/PUT_upload_from_file"
+    #   VCR.use_cassette(name, allow_playback_repeats: true) do
+    #     @yandex.disk.upload_from_file(upload_link: test_upload_link, src: test_file_path)
+    #     CassetteHelpers::Use.new(name) do |c|
+    #       expect(c.url).to eq(upload_link)
+    #       expect(c.code).to eq(201)
+    #       expect(c.method).to eq("put")
+    #     end
+    #   end
+    # end
+
+    it "#upload_by_url", :vcr do
+      name = "disk/POST_upload_by_url"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        path = "uploaded_by_url.png"
+        link = "https://www.example.com/image.png"
+        @yandex.disk.upload_by_url(path: path, url: link)
+
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/upload?path=#{path}&url=#{link}")
+          expect(c.code).to eq(202)
+          expect(c.method).to eq("post")
+        end
+      end
+    end
+
+    it "#get_meta", :vcr do
+      name = "disk/GET_get_meta"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.get_meta(path: "remote_file.txt")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources?path=/remote_file.txt")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::Resource)
+      end
+    end
+
+    it "#update_meta", :vcr do
+      name = "disk/PATCH_update_meta"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.update_meta(path: "remote_file.txt", key_one: "value_1", key_two: "value_2")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("patch")
+        end
+        expect(resp).to be_instance_of(Yadisk::Resource)
+      end
+    end
+
+    it "#create_dir", :vcr do
+      name = "disk/PUT_create_dir"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.create_dir(path: "test_dir")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#copy", :vcr do
+      name = "disk/POST_copy"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.copy(from: "remote_file.txt", to: "remote_file_copy.txt")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/copy")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("post")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#download", :vcr do
+      name = "disk/GET_download"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.download(path: "remote_file.txt")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    # it "#list_files", :vcr do
+    #   name = "disk/GET_list_files"
+    #   VCR.use_cassette(name, allow_playback_repeats: true) do
+    #     @yandex.disk.list_files
+    #     CassetteHelpers::Use.new(name) do |c|
+    #       expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources")
+    #       expect(c.code).to eq(200)
+    #       expect(c.method).to eq("get")
+    #     end
+    #     expect(resp).to be_instance_of(Yadisk::Disk)
+    #   end
+    # end
+
+    # TODO: filter sensitive data
+    # it "#last_uploaded", :vcr do
+    #   name = "disk/GET_last_uploaded"
+    #   VCR.use_cassette(name, allow_playback_repeats: true) do
+    #     resp = @yandex.disk.last_uploaded
+    #     CassetteHelpers::Use.new(name) do |c|
+    #       expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources")
+    #       expect(c.code).to eq(200)
+    #       expect(c.method).to eq("get")
+    #     end
+    #     expect(resp).to be_instance_of(Yadisk::Collection)
+    #   end
+    # end
+
+    it "#move", :vcr do
+      name = "disk/POST_move"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.move(from: "remote_file_copy.txt", to: "remote_file_new_name.txt")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/move")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("post")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#list_public", :vcr do
+      name = "disk/GET_list_public"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.list_public
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/public")
+          expect(c.code).to eq(200)
+          expect(c.meth).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::Collection)
+      end
+    end
+
+    it "#publish", :vcr do
+      name = "disk/PUT_publish"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.publish(path: test_file_name)
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/publish")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("put")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#unpublish", :vcr do
+      name = "disk/PUT_unpublish"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.disk.unpublish(path: test_file_name)
+        CassetteHelpers::Use.new(name).url do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources/unpublish")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("put")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#delete", :vcr do
+      name = "disk/DELETE_delete"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        @yandex.disk.delete(path: test_file_name)
+        CassetteHelpers::Use.new(name).url do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources?path=remote_file.txt")
+          expect(c.code).to eq(204)
+          expect(c.method).to eq("delete")
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/lib/yadisk/errors_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Yadisk::Client do
+  context "client with bad credentials.", :vcr do
+    let(:client) { Yadisk::Client.new(token: "very bad token").disk.info }
+    let(:name) { "disk/ERROR_info" }
+    it "UnauthorizedError" do
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        expect { client }.to raise_error(Yadisk::Error)
+          .with_message(/did not supply valid authentication/)
+      end
+    end
+  end
+end

data/spec/lib/yadisk/operations_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Yadisk::Client do
+  # TODO: describe > context > it
+  context "#operations" do
+    it "#status", :vcr do
+      name = "operations/GET_status"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        id = "a6e706d94c4adcd17298c1eed06729f9e9217569e6376a51c38de74d8d6367c5"
+        resp = @yandex.operation.status(operation_id: id)
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/operations/#{id}")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(String)
+        expect(resp).to eq("in-progress")
+      end
+    end
+  end
+end

data/spec/lib/yadisk/public_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+# TODO: make specs code cleaner
+# TODO: describe > context > it
+describe Yadisk::Client do
+  context "#public" do
+    it "#meta", :vcr do
+      name = "public/GET_meta"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        url = "https://disk.yandex.ru/d/Th-o2SkdjoALxA"
+        resp = @yandex.public_resource.meta(public_url: url)
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/operations/#{id}")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::PublicResource)
+      end
+    end
+
+    it "#link", :vcr do
+      name = "public/GET_link"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        url = "https://disk.yandex.ru/d/Th-o2SkdjoALxA"
+        resp = @yandex.public_resource.link(public_url: url)
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/operations/#{id}")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#save", :vcr do
+      name = "public/POST_save"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        url = "https://disk.yandex.ru/d/Th-o2SkdjoALxA"
+        resp = @yandex.public_resource.save(public_url: url)
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/operations/#{id}")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("post")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+  end
+end

data/spec/lib/yadisk/trash_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Yadisk::Client do
+  let(:file_path) { "trash:/remote_path.txt_05572eeb69f47093eac51b40f1513d3bddff1b6c" }
+  context "#trash" do
+    it "#list - all", :vcr do
+      name = "trash/GET_list"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.trash.list(path: "/")
+        CassetteHelpers::Use.new(name).url do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/trash/resources")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::TrashResource)
+      end
+    end
+
+    it "#list - single file", :vcr do
+      name = "trash/GET_list"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.trash.list(path: file_path)
+        CassetteHelpers::Use.new(name).url do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/trash/resources")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("get")
+        end
+        expect(resp).to be_instance_of(Yadisk::TrashResource)
+      end
+    end
+
+    it "#restore", :vcr do
+      name = "trash/PUT_restore"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.trash.restore(path: file_path)
+        CassetteHelpers::Use.new(name).url do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/resources?path=remote_path.txt")
+          expect(c.code).to eq(204)
+          expect(c.method).to eq("put")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    it "#delete - ok", :vcr do
+      name = "trash/DELETE_delete"
+      VCR.use_cassette(name, allow_playback_repeats: true) do
+        resp = @yandex.trash.delete(path: "trash:/remote_file.txt_f7fc32168f3b30e60994fd2e82af7d230dab5c91")
+        CassetteHelpers::Use.new(name) do |c|
+          expect(c.url).to eq("https://cloud-api.yandex.net/v1/disk/trash/resources")
+          expect(c.code).to eq(200)
+          expect(c.method).to eq("delete")
+        end
+        expect(resp).to be_instance_of(Yadisk::Link)
+      end
+    end
+
+    # if error raised
+    describe "#delete - DiskNotFoundError" do
+      let(:request) { @yandex.trash.delete(path: file_path) }
+      it "#delete - file not found", :vcr do
+        name = "trash/DELETE_delete_error"
+        VCR.use_cassette(name, allow_playback_repeats: true) do
+          expect { request }.to raise_error(Yadisk::Error)
+            .with_message(/DiskNotFoundError/)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "./spec/support/cassette_helpers" # VCR helpers
+require File.expand_path("./vcr_setup", __dir__)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require_relative "../lib/yadisk"
+
+RSpec.configure do |config|
+  config.include CassetteHelpers
+  config.before(:each) do
+    @yandex = Yadisk::Client.new(token: "your_access_token_for_e2e")
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = %i[expect]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = %i[expect]
+  end
+end

data/spec/support/cassette_helpers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CassetteHelpers
+  class Use
+    def initialize(name)
+      path = "spec/vcr/#{name}.yml"
+      @cassette = YAML.load_file(path) if File.exist?(path)
+    end
+
+    # helper method for match request URL from cassette
+    def url
+      @cassette["http_interactions"].first["request"]["uri"]
+    end
+
+    def method
+      @cassette["http_interactions"].first["request"]["method"]
+    end
+
+    def code
+      @cassette["http_interactions"].first["response"]["status"]["code"]
+    end
+  end
+end

data/spec/test_data/test_file.txt

@@ -0,0 +1 @@
+test upload method

data/spec/vcr/disk/DELETE_delete.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://cloud-api.yandex.net/v1/disk/resources?path=remote_file.txt
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.10.2
+      Authorization:
+      - "[**********]"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: NO CONTENT
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Wed, 05 Oct 2022 14:32:20 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Methods:
+      - PUT, PATCH, DELETE, GET, OPTIONS
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Yandex-Cloud-Request-Id:
+      - omitted
+      Cache-Control:
+      - no-cache
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Accept-Language, Accept, X-Uid, X-HTTP-Method, X-Requested-With, Content-Type,
+        Authorization
+    body:
+      encoding: UTF-8
+      string: ''
+  recorded_at: Wed, 05 Oct 2022 14:32:20 GMT
+recorded_with: VCR 6.1.0