uploadcare-ruby 2.1.1 → 3.1.0.pre.rc1

data/.travis.yml

@@ -1,26 +0,0 @@
-# currently supported rubies: https://www.ruby-lang.org/en/downloads/branches/
-
-language: ruby
-
-rvm:
-  - 1.9.3
-  - 2.2
-  - 2.3
-  - 2.4
-  - ruby-head
-
-jobs:
-  include:
-    - stage: style checks
-      rvm: 2.4
-      before_install:
-        - gem install rubocop
-      script:
-        - rubocop
-
-  allow_failures:
-    - stage: style checks
-    - rvm: ruby-head
-
-before_install:
-  - gem update bundler

data/UPGRADE_NOTES.md

@@ -1,36 +0,0 @@
-# Upgrade notes
-
-## v1.* -> v2.*
-
-In 2.* release we've moved to [REST API v0.5][uploadcare-changelog-rest-api-v05] which introduces a new pagination for `/files/` and `/groups/` endpoints, so `Uploadcare::Api::FileList` and `Uploadcare::Api::GroupList` were completely reimplemented. 
-
-Previously, the file/group list API was:
-
-```ruby
-# creating
-list = api.file_list # => #<Uploadcare::Api::FileList page=1 ...>
-
-# accessing files/groups
-list.results # => [#<Uploadcare::Api::File>, ...]
-
-# pagination
-list.next_page # => #<Uploadcare::Api::FileList page=2 ...>
-list.previous_page # => #<Uploadcare::Api::FileList page=1 ...>
-list.go_to 5 # => #<Uploadcare::Api::FileList page=5 ...>
-
-# metadata
-list.pages # => 15
-list.page # => 5
-list.total # => 308 (files in a project)
-```
-
-It **won't work anymore**. For the details on the new file/group lists interface see [readme][readme]
-
-The core features of the new file/group list API are: 
-
-- transparent pagination via enumerable interface
-- loading objects on demand
-- ordering, filtering and slicing
-
-[uploadcare-changelog-rest-api-v05]: https://uploadcare.com/changelog/tag/rest-api#rest-api-version-05
-[readme]: https://github.com/uploadcare/uploadcare-ruby#file-lists

data/lib/uploadcare/api.rb

@@ -1,26 +0,0 @@
-require 'json'
-require 'ostruct'
-Dir[File.dirname(__FILE__) + '/utils/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/errors/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/rest/middlewares/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/rest/connections/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/rest/auth/*.rb'].sort.each {|file| require file }
-Dir[File.dirname(__FILE__) + '/api/validators/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/api/*.rb'].each {|file| require file }
-Dir[File.dirname(__FILE__) + '/resources/*.rb'].each {|file| require file }
-
-
-module Uploadcare
-  class Api
-    attr_reader :options
-
-    include Uploadcare::RawApi
-    include Uploadcare::UploadingApi
-    include Uploadcare::FileApi
-    include Uploadcare::ProjectApi
-    include Uploadcare::FileListApi
-    include Uploadcare::GroupApi
-    include Uploadcare::GroupListApi
-    include Uploadcare::FileStorageApi
-  end
-end

data/lib/uploadcare/api/file_api.rb

@@ -1,7 +0,0 @@
-module Uploadcare
-  module FileApi
-    def file uuid_or_cdn_url
-      file = Uploadcare::Api::File.new self, uuid_or_cdn_url
-    end
-  end
-end

data/lib/uploadcare/api/file_list_api.rb

@@ -1,19 +0,0 @@
-module Uploadcare
-  module FileListApi
-    # Available options:
-    #
-    #   limit -- a number of objects retrieved per request. Default: 100
-    #   ordering -- sorting order of files in a list. Default: datetime_uploaded
-    #   from -- a starting point for filtering files.
-    #   stored -- true to include only stored files, false to exclude.
-    #   removed -- true to include only removed files, false to exclude. Default: false
-    #
-    # Documentation: http://uploadcare.com/documentation/rest/#file-files
-    def file_list options={}
-      Validators::FileListOptionsValidator.new(options).validate
-
-      data = get '/files/', options
-      Uploadcare::Api::FileList.new self, data, options
-    end
-  end
-end

data/lib/uploadcare/api/file_storage_api.rb

@@ -1,34 +0,0 @@
-module Uploadcare
-  module FileStorageApi
-    MAX_BATCH_SIZE = 100
-    UUID_REGEX = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
-
-    def store_files(objects)
-      if objects.size > MAX_BATCH_SIZE
-        raise ArgumentError, "Up to #{MAX_BATCH_SIZE} files are supported per request, #{objects.size} given"
-      end
-
-      put "/files/storage/", to_uuids(objects)
-    end
-
-    def delete_files(objects)
-      if objects.size > MAX_BATCH_SIZE
-        raise ArgumentError, "Up to #{MAX_BATCH_SIZE} files are supported per request, #{objects.size} given"
-      end
-
-      delete "/files/storage/", to_uuids(objects)
-    end
-
-    private
-
-    def to_uuids(objects)
-      objects.map do |object|
-        case object
-        when Uploadcare::Api::File then object.uuid
-        when UUID_REGEX then object
-        else raise(ArgumentError, "Unable to convert object to uuid: #{object}")
-        end
-      end
-    end
-  end
-end

data/lib/uploadcare/api/group_api.rb

@@ -1,38 +0,0 @@
-module Uploadcare
-  module GroupApi
-
-    def group uuid_or_cdn_url
-      group = Uploadcare::Api::Group.new self, uuid_or_cdn_url
-    end
-
-
-    def create_group ary
-      unless ary.kind_of?(Array)
-        raise ArgumentError.new "You should send and array of files or valid UUIDs"
-      else
-        if ary.select {|f| !!f.kind_of?(Uploadcare::Api::File) }.any?
-          files = Hash.new
-          ary.each_with_index do |file, i|
-            files["files[#{i}]"] = file.uuid
-          end
-        elsif ary.select {|f| !!f.kind_of?(String) }.any?
-          files = Hash.new
-          ary.each_with_index do |uuid, i|
-            files["files[#{i}]"] = uuid
-          end
-        else
-          raise ArgumentError.new "You should send and array of files or valid UUIDs"
-        end
-      end
-
-
-      data = {
-        pub_key: @options[:public_key],
-      }
-
-      data.merge! files
-      post = @upload_connection.send :post, "/group/", data
-      group = Uploadcare::Api::Group.new self, post.body["id"], post.body
-    end
-  end
-end

data/lib/uploadcare/api/group_list_api.rb

@@ -1,17 +0,0 @@
-module Uploadcare
-  module GroupListApi
-    # Available options:
-    #
-    #   limit -- a number of objects retrieved per request. Default: 100
-    #   ordering -- sorting order of groups in a list. Default: datetime_creataed
-    #   from -- a starting point for filtering groups.
-    #
-    # Documentation: http://uploadcare.com/documentation/rest/#group-groups
-    def group_list options={}
-      Validators::GroupListOptionsValidator.new(options).validate
-
-      data = get '/groups/', options
-      list = Uploadcare::Api::GroupList.new self, data, options
-    end
-  end
-end

data/lib/uploadcare/api/project_api.rb

@@ -1,9 +0,0 @@
-require "uri"
-
-module Uploadcare
-  module ProjectApi
-    def project
-      @project ||= Uploadcare::Api::Project.new self 
-    end
-  end
-end

data/lib/uploadcare/api/raw_api.rb

@@ -1,38 +0,0 @@
-require 'json'
-
-module Uploadcare
-  module RawApi
-    def initialize(options = {})
-      @options = Uploadcare::default_settings.merge(options)
-      @api_connection = Uploadcare::Connections::ApiConnection.new(@options)
-      @upload_connection = Uploadcare::Connections::UploadConnection.new(@options)
-    end
-
-    # basic request method
-    def request(method = :get, path = '/files/', params = {})
-      response = @api_connection.send method, path, params
-      response.body
-    end
-    alias_method :api_request, :request
-
-    # request with GET verb
-    def get(path = '/files/', params = {})
-      request :get, path, params
-    end
-
-    # request with POST verb
-    def post(path = '/files/', params = {})
-      request :post, path, params
-    end
-
-    # request with PUT verb
-    def put(path = '/files/', params = {})
-      request :put, path, params
-    end
-
-    # request with DELETE verb
-    def delete(path = '/files/', params = {})
-      request :delete, path, params
-    end
-  end
-end

data/lib/uploadcare/api/uploading_api.rb

@@ -1,71 +0,0 @@
-require_relative 'uploading_api/upload_params'
-
-module Uploadcare
-  module UploadingApi
-    # intelegent guess for file or URL uploading
-    def upload(object, options = {})
-      case object
-      when File then upload_file(object, options)
-      when Array then upload_files(object, options)
-      # if object is a string, try to upload it as an URL
-      when String then upload_url(object, options)
-      else
-        raise ArgumentError, "Expected `object` to be an Uploadcare::Api::File, "\
-          "an Array or a valid URL string, received: `#{object}`"
-      end
-    end
-
-    # Upload multiple files
-    def upload_files(files, options = {})
-      data = upload_params(options).for_file_upload(files)
-
-      response = @upload_connection.post('/base/', data)
-
-      response.body.values.map! { |f| Uploadcare::Api::File.new(self, f) }
-    end
-
-    # Upload single file
-    def upload_file(file, options = {})
-      upload_files([file], options).first
-    end
-    alias_method :create_file, :upload_file
-
-    # Upload from an URL
-    def upload_url(url, options = {})
-      params = upload_params(options).for_url_upload(url)
-      token = request_file_upload(params)
-
-      upload_status = poll_upload_result(token)
-      if upload_status['status'] == 'error'
-        raise ArgumentError.new(upload_status['error'])
-      end
-
-      Uploadcare::Api::File.new(self, upload_status['file_id'])
-    end
-    alias_method :upload_from_url, :upload_url
-
-    private
-
-    def get_status_response(token)
-      response = @upload_connection.post('/from_url/status/', {token: token})
-      response.body
-    end
-
-    def request_file_upload(upload_params)
-      response = @upload_connection.post('/from_url/', upload_params)
-      token = response.body['token']
-    end
-
-    def poll_upload_result(token)
-      while true
-        response = get_status_response(token)
-        break(response) if ['success', 'error'].include?(response['status'])
-        sleep 0.5
-      end
-    end
-
-    def upload_params(request_options)
-      UploadParams.new(@options, request_options)
-    end
-  end
-end

data/lib/uploadcare/api/uploading_api/upload_params.rb

@@ -1,72 +0,0 @@
-require 'uri'
-require 'mime/types'
-
-module Uploadcare
-  module UploadingApi
-    class UploadParams
-      def initialize(global_options, request_options)
-        @global_options = global_options
-        @request_options = request_options
-      end
-
-      def for_url_upload(url)
-        {
-          source_url: parse_url(url),
-          pub_key: public_key,
-          store: store
-        }.reject { |k, v| v.nil? }
-      end
-
-      def for_file_upload(files)
-        {
-          UPLOADCARE_PUB_KEY: public_key,
-          UPLOADCARE_STORE: store
-        }.reject { |k, v| v.nil? }.merge(file_params(files))
-      end
-
-      private
-
-      attr_reader :global_options, :request_options
-
-      def public_key
-        global_options[:public_key]
-      end
-
-      def store
-        mapping = { true => 1, false => 0, auto: 'auto' }
-
-        global_value = global_options[:autostore]
-        per_request_value = request_options[:store]
-
-        mapping[per_request_value] || mapping[global_value]
-      end
-
-      def file_params(files)
-        Hash[files.map.with_index { |file, i| ["file[#{i}]", build_upload_io(file)] }]
-      end
-
-      def parse_url(url)
-        uri = URI.parse(url)
-
-        unless uri.is_a?(URI::HTTP) # will also be true for https
-          raise ArgumentError, 'invalid url was given'
-        end
-
-        uri
-      end
-
-      def build_upload_io(file)
-        unless file.is_a?(File)
-          raise ArgumentError, "expected File object, #{file} given"
-        end
-
-        Faraday::UploadIO.new file.path, extract_mime_type(file)
-      end
-
-      def extract_mime_type file
-        types = MIME::Types.of(file.path)
-        types[0].content_type
-      end
-    end
-  end
-end

data/lib/uploadcare/api/validators/file_list_options_validator.rb

@@ -1,73 +0,0 @@
-module Uploadcare
-  module Validators
-
-    class FileListOptionsValidator
-      SUPPORTED_KEYS = [:from, :ordering, :limit, :stored, :removed]
-
-      def initialize(options)
-        @options = options
-      end
-
-      def validate
-        check_for_unsupported_keys(@options)
-
-        validate_limit(@options[:limit])
-        validate_stored(@options[:stored])
-        validate_removed(@options[:removed])
-        validate_ordering_and_from(@options[:ordering], @options[:from])
-      end
-
-      private
-
-      def check_for_unsupported_keys(options)
-        unsupported_keys = options.keys.reject{|k,_| SUPPORTED_KEYS.include?(k)}
-        error("Unknown options: #{unsupported_keys}") if unsupported_keys.any?
-      end
-
-      def validate_ordering_and_from(ordering, from)
-        case ordering
-        when nil, /^-?datetime_uploaded$/
-          validate_from_as_date(from)
-        when /^-?size$/
-          validate_from_as_size(from)
-        else
-          error("Unknown value for :ordering option: #{ordering.inspect}")
-        end
-      end
-
-      def validate_from_as_date(from)
-        return if from.nil? || from.to_s =~ /^\d{4}-\d{2}-\d{2}T\d{2}.*/
-        error(":from value should be a DateTime or an iso8601 string when "\
-          "ordering is `datetime_uploaded` or `-datetime_uploaded`, "\
-          "#{from.inspect} given")
-      end
-
-      def validate_from_as_size(from)
-        return if from.nil? || (from.is_a?(Integer) && from >= 0)
-        error(":from value should be a positive integer when ordering is "\
-          "`size` or `-size`, #{from.inspect} given")
-      end
-
-      def validate_limit(limit)
-        return if limit.nil? || (limit.is_a?(Integer) && (1..1000).include?(limit))
-        error(":limit should be a positive integer from 1 to 1000, "\
-          "#{limit.inspect} given")
-      end
-
-      def validate_stored(stored)
-        return if [nil, true, false].include?(stored)
-        error(":stored can be true or false, #{stored.inspect} given")
-      end
-
-      def validate_removed(removed)
-        return if [nil, true, false].include?(removed)
-        error(":removed can be true or false, #{removed.inspect} given")
-      end
-
-      def error(message)
-        raise ArgumentError, message
-      end
-    end
-
-  end
-end