uploadcare-ruby 1.2.2 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9363abb3c073881cc706fb59bc0b3d3b537a5db0fc53f4a186a726873bf622a6
-  data.tar.gz: ebdda4fafed6775f6904a9b4e1737241234d244ed42bed8c00a9fe1368d32027
+  metadata.gz: e78e5ae5b01f3ca9834186dbd80f7498a1ebec2491740e4b4d5a0aa2845e34e5
+  data.tar.gz: 84a34cf0fdc9cda596cc54b1b60df014d4d4b3f3882e8f3dad7344ae230c7c2f
 SHA512:
-  metadata.gz: 9065fb7d524d457237d6ed507c405e4c83c8fb0de0f9a194dd259b35726353c6ea3dd96c23fd26f4a968784108cc6d8b2c6c593fb487345465e77c6b7960d9fb
-  data.tar.gz: f265a7b3fbcd3fcf716019edd99668b9b763463feaf46aeecc69accbe81bd5585b24ab6a31592fc8badac78c109228271ab95862ff811044beb4585d7c75e9c7
+  metadata.gz: 1efbec0c9e65cf94a769c206490090244628dd16952db2218e7dae5f004ed8b29c9b02855e48d7048006f125c4f019c17c03f40df1dc0db1d2fbd3cdfebf5e75
+  data.tar.gz: aa3ac3a9e392c105d8be4d405323e645fe07406fe14bf9cc579b4dc3852a2853f15c2dc18d492831284f8cb6343a84f3ffb34f028b3d822d9cd5f738ecb67f17

data/.github/workflows/gem-push.yml

@@ -0,0 +1,20 @@
+name: Publish Gem
+
+on:
+  push:
+    tags:
+      - v*
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Release Gem
+        if: contains(github.ref, 'refs/tags/v')
+        uses: cadwallion/publish-rubygems-action@v1.0.0
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RELEASE_COMMAND: rake release

data/.github/workflows/ruby.yml

@@ -0,0 +1,52 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [
+          '2.4', '2.5', # eol
+          '2.6', '2.7', # maintained
+        ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        UPLOADCARE_PUBLIC_KEY: demopublickey
+        UPLOADCARE_SECRET_KEY: demoprivatekey
+
+  style-check:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      matrix:
+        ruby-version: ['2.7',]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Install Rubocop
+      run: gem install rubocop
+    - name: Check codestyle
+      run: rubocop

data/.gitignore

@@ -1,6 +1,14 @@
-Gemfile.lock
-.ruby-gemset
-.ruby-version
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/fixtures/big.jpeg
 
-*.DS_Store
-*.gem
+# rspec failure tracking
+.rspec_status
+.byebug_history
+Gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Metrics/LineLength:
+  Max: 120
+
+IneffectiveAccessModifier:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'bin/'
+    - 'spec/**/*'
+    - 'uploadcare-ruby.gemspec'
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,4 @@
+-
+DEVELOPMENT.md
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -1,41 +1,41 @@
 # Changelog
-All notable changes to this project will be documented in this file.
 
-The format is based now on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
-and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+## 3.0.5 2021-04-15
 
-### [1.2.2] - 2018-06-11
+- Replace Travis-CI with Github Actions
+- Automate gem pushing
 
-### Fixed
-- Show Uploadcare::USER_AGENT deprecation warning only when the constant is being used
+## 3.0.4-dev 2020-03-19
 
-### [1.2.1] - 2018-05-24
-
-### Changed
-- Allow user to override User-Agent header
-- User-Agent format reports gem name, version and environment
+- Added better pagination methods for GroupList & FileList
+- Improved documentation and install instructions
+- Added CI
 
+## 3.0.3-dev 2020-03-13
+- Added better pagination and iterators for GroupList & FileList
 
-## 1.1.0 - 2017-03-21
+## 3.0.2-dev 2020-03-11
 
-### Added
-- Added to new methods to `Uploadcare::Api::File`, `#internal_copy` and `#external_copy`.
-- Added support of [secure authorization](https://uploadcare.com/documentation/rest/#request) for REST API. It is now used by default (can be overriden in config)
+- Expanded File and Group entities
+- Changed user agent syntax
 
-### Fixed
-- Fixed middleware names that could break other gems ([#13](https://github.com/uploadcare/uploadcare-ruby/issues/13)).
+## 3.0.1-dev 2020-03-11
 
-### Deprecated
-- `Uploadcare::Api::File#copy` in favor of `#internal_copy` and `#external_copy`.
+- Added Upload/group functionality
+- Added user API
+- Added user agent
+- Isolated clients, entities and concerns
+- Expanded documentation
 
+## 3.0.0-dev 2020-02-18
 
-## 1.0.6 - 2017-01-30
+### Changed
+- Rewrote gem from scratch
 
 ### Added
-- Ruby version and public API key sent via User-Agent header (can be overriden in config)
-
-### Fixed
-- Incorrect dependencies
-
 
-[1.2.1]: https://github.com/uploadcare/uploadcare-ruby/compare/6dde...v1.2.1
+- Client wrappers for REST API
+- Serializers for REST API
+- Client wrappers for Upload API
+- Serializers for Upload API
+- rdoc documentation

data/DEVELOPMENT.md

@@ -0,0 +1,18 @@
+## How to contribute
+
+https://github.com/uploadcare/.github/blob/master/CONTRIBUTING.md
+
+## Useful docs
+
+### Uploadcare:
+
+* https://uploadcare.com/docs/api_reference/
+* https://uploadcare.com/api-refs/rest-api/
+
+### ApiStruct:
+
+* https://github.com/rubygarage/api_struct/
+
+## Uploadcare-ruby gem architecture
+
+![http://www.plantuml.com/plantuml/uml/bPHDRzj838Rl-XM4zn1WiHRsOoyR88iuXOFcKWHDqcimaLxBquvcL9AowtxyzqepqYGrYY050cH69X-IByav5pMiVUkAed96X5QTfIy54T7jrWgDVrx16rE1De6fGKkzW2NQB9VB-7_zoRIT0zLmQ8oYfXQw3RMS9ZFgEnTCFLqsrk7UMT7YsnnsxTNguIZoNNIg38DMrrU4P2DWQvpz32wZzPtqnha3MStXXH9rIe8qq2jduPMSEO3_Y7x6rzJ0WwD3fjOK7jwZKg4DXvOOqWKlIB6klAZn5JBPS3v7UOQJ83j9-RnAASsNQHNlPsTdFv3iKJu9yJjT1gPBwp0ZHGCZdMDqHPP-LkPH-YGIjSQR1aACZpr4HnMFElApudwryMyXeUSAzDl5nSMGn0XIUB71HqLJrosacAj_4vHwGKtMqp_bd-LVongxH-0DU6ShJFMyCsn3BxI5wy1JQnDudS77LMJTfdfNjUaKFDnrb4Uc23KgMsDWXprfI7lICPHEKj4d4PBqe0SpfXmyTHnsjivZTZBDQlca8S5NO2zJ2Mlcm5GPhRPWYMEB-6ax71tusG8MY-Xu7praiI0sLY13dpceEYHuDBQRk6KCxTbBdc7QMzrI5MhGlt__bx4f-BqcZlNDm5Rp0K9cAZbcgcmH9uTxJrR9DCRw56-_XSSEF7vke4SvFSfnRTYqUJmXo5qqd5VDFhZfVKeRFIH4kwdthszlhwaRAL6gED2MCVJay8A1pfDyOnjlj6VCCGBBcEMgiuFFr__dD-mqx_VJ1sZ-DTPKf4joc_RlzBdNosC_sHLvOSe9ESFAUVIBYLWcwOeyJ-NCE8Ul-zPz1m00](http://www.plantuml.com/plantuml/svg/bPHDRzj838Rl-XM4zn1WiHRsOoyR88iuXOFcKWHDqcimaLxBquvcL9AowtxyzqepqYGrYY050cH69X-IByav5pMiVUkAed96X5QTfIy54T7jrWgDVrx16rE1De6fGKkzW2NQB9VB-7_zoRIT0zLmQ8oYfXQw3RMS9ZFgEnTCFLqsrk7UMT7YsnnsxTNguIZoNNIg38DMrrU4P2DWQvpz32wZzPtqnha3MStXXH9rIe8qq2jduPMSEO3_Y7x6rzJ0WwD3fjOK7jwZKg4DXvOOqWKlIB6klAZn5JBPS3v7UOQJ83j9-RnAASsNQHNlPsTdFv3iKJu9yJjT1gPBwp0ZHGCZdMDqHPP-LkPH-YGIjSQR1aACZpr4HnMFElApudwryMyXeUSAzDl5nSMGn0XIUB71HqLJrosacAj_4vHwGKtMqp_bd-LVongxH-0DU6ShJFMyCsn3BxI5wy1JQnDudS77LMJTfdfNjUaKFDnrb4Uc23KgMsDWXprfI7lICPHEKj4d4PBqe0SpfXmyTHnsjivZTZBDQlca8S5NO2zJ2Mlcm5GPhRPWYMEB-6ax71tusG8MY-Xu7praiI0sLY13dpceEYHuDBQRk6KCxTbBdc7QMzrI5MhGlt__bx4f-BqcZlNDm5Rp0K9cAZbcgcmH9uTxJrR9DCRw56-_XSSEF7vke4SvFSfnRTYqUJmXo5qqd5VDFhZfVKeRFIH4kwdthszlhwaRAL6gED2MCVJay8A1pfDyOnjlj6VCCGBBcEMgiuFFr__dD-mqx_VJ1sZ-DTPKf4joc_RlzBdNosC_sHLvOSe9ESFAUVIBYLWcwOeyJ-NCE8Ul-zPz1m00)

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in uploadcare-ruby.gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Uploadcare, LLC
+Copyright (c) 2021 Uploadcare Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,112 +1,90 @@
-[![Build Status](https://secure.travis-ci.org/uploadcare/uploadcare-ruby.png?branch=master)](http://travis-ci.org/uploadcare/uploadcare-ruby)
+# Ruby integration for Uploadcare
 
-A [Ruby](https://www.ruby-lang.org/en/) wrapper for [Uploadcare](https://uploadcare.com).
+![license](https://img.shields.io/badge/license-MIT-brightgreen.svg)
+[![Build Status][actions-img]][actions-badge]
+[![Uploadcare stack on StackShare][stack-img]][stack]
+<!--[![Coverage Status][coverals-img]][coverals]-->
 
-## Installation
+[actions-badge]: https://github.com/uploadcare/uploadcare-ruby/actions/workflows/ruby.yml
+[actions-img]: https://github.com/uploadcare/uploadcare-ruby/actions/workflows/ruby.yml/badge.svg
+[coverals-img]: https://coveralls.io/repos/github/uploadcare/uploadcare-ruby/badge.svg?branch=main
+[coverals]: https://coveralls.io/github/uploadcare/uploadcare-ruby?branch=main
+[stack-img]: https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat
+[stack]: https://stackshare.io/uploadcare/stacks/
 
-Installing `uploadcare-ruby` is quite simple and takes a couple of steps.
-First of, add the following line to your app's Gemfile:
 
-```ruby
-gem 'uploadcare-ruby'
-```
+Uploadcare Ruby integration handles uploads and further operations with files by
+wrapping Upload and REST APIs.
 
-Once you've added the line, execute this:
+* [Installation](#installation)
+* [Usage](#usage)
+* [Useful links](#useful-links)
 
-```shell
-$ bundle install
-```
+## Requirements
+* ruby 2.4+
 
-Or that (for manual install):
+## Compatibility
 
-```shell
-$ gem install uploadcare-ruby
-```
+Note that `uploadcare-ruby` **3.x** is not backward compativble with 
+**[2.x](https://github.com/uploadcare/uploadcare-ruby/tree/v2.x)**.
 
-## Initialization
+## Installation
 
-Init is simply done through creating an API object.
+Add this line to your application's Gemfile:
 
 ```ruby
-require 'uploadcare'
+gem 'uploadcare-ruby'
+```
 
-@api = Uploadcare::Api.new # default settings are used
+And then execute:
 
-@api = Uploadcare::Api.new(settings) # using user-defined settings
-```
+    $ bundle
 
-Here's how the default settings look like:
-
-``` ruby
-  {
-    public_key: 'demopublickey',   # you need to override this
-    private_key: 'demoprivatekey', # you need to override this
-    upload_url_base: 'https://upload.uploadcare.com',
-    api_url_base: 'https://api.uploadcare.com',
-    static_url_base: 'https://ucarecdn.com',
-    api_version: '0.3',
-    cache_files: true,
-    auth_scheme: :secure
-  }
+If already not, create your project in [Uploadcare dashboard](https://uploadcare.com/dashboard/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby) and copy
+its API keys from there.
+
+Set your Uploadcare keys in config file or through environment variables:
+```bash
+export UPLOADCARE_PUBLIC_KEY=demopublickey
+export UPLOADCARE_SECRET_KEY=demoprivatekey
 ```
 
-You're free to use both `demopublickey` and `demoprivatekey`
-for initial testing purposes. We wipe out files loaded to our
-demo account periodically. For a better experience,
-consider creating an Uploadcare account. Check out
-[this](http://kb.uploadcare.com/article/234-uc-project-and-account)
-article to get up an running in minutes.
+Or configure your app yourself if you are using different way of storing keys.
+Gem configuration is available in `Uploadcare.configuration`. Full list of
+settings can be seen in [`lib/uploadcare.rb`](lib/uploadcare.rb)
 
-Please note, in order to use [Upload API](https://uploadcare.com/documentation/upload/)
-you will only need the public key alone. However, using 
-[REST API](https://uploadcare.com/documentation/rest/) requires you to
-use both public and private keys for authentication.  
-While “private key” is a common way to name a key from an
-authentication key pair, the actual thing for our `auth-param` is `secret_key`.
+```ruby
+# your_config_initializer_file.rb
+Uploadcare.config.public_key = 'demopublickey'
+Uploadcare.config.secret_key = 'demoprivatekey'
+```
 
 ## Usage
 
-This section contains practical usage examples. Please note,
-everything that follows gets way more clear once you've looked
-through our docs [intro](https://uploadcare.com/documentation/).
+This section contains practical usage examples. Please note, everything that
+follows gets way more clear once you've looked through our
+[docs](https://uploadcare.com/docs/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby).
 
-### Basic usage: uploading a single file, manipulations
+### Uploading and storing a single file
 
 Using Uploadcare is simple, and here are the basics of handling files.
 
-First of, create the API object:
-
-```ruby
-@api = Uploadcare::Api.new(CONFIG)
-
-```
-
-And yeah, now you can upload a file:
-
 ```ruby
 @file_to_upload = File.open("your-file.png")
 
-@uc_file = @api.upload(@file_to_upload)
-# => #<Uploadcare::Api::File ...
-```
-
-Then, let's check out UUID and URL of the
-file you've just uploaded:
+@uc_file = Uploadcare::Uploader.upload(@file_to_upload)
 
-```ruby
-# file uuid (you'd probably want to store those somewhere)
 @uc_file.uuid
 # => "dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
 
-# url for the file, can be used with your website or app right away
+# URL for the file, can be used with your website or app right away
 @uc_file.cdn_url
 # => "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/"
 ```
 
-Your might then want to store or delete the uploaded file.
-Storing files could be crucial if you aren't using the
-“Automatic file storing” option for your Uploadcare project.
-If not stored manually or automatically, files get deleted
+Your might then want to store or delete the uploaded file. Storing files could
+be crucial if you aren't using the “Automatic file storing” option for your
+Uploadcare project. If not stored manually or automatically, files get deleted
 within a 24-hour period.
 
 ```ruby
@@ -119,519 +97,213 @@ within a 24-hour period.
 # => #<Uploadcare::Api::File ...
 ```
 
-### Uploading a file from URL
+### Uploads
 
-Now, this one is also quick. Just pass your URL into our API
-and you're good to go.
+Uploadcare supports multiple ways to upload files:
 
 ```ruby
-# the smart upload
-@file  = @api.upload "http://your.awesome/avatar.jpg" 
-# =>  #<Uploadcare::Api::File ...
-
-# use this one if you want to explicitly upload from URL
-@file = @api.upload_from_url "http://your.awesome/avatar.jpg" 
-# =>  #<Uploadcare::Api::File ...
+# Smart upload - detects type of passed object and picks appropriate upload method
+Uploadcare::Uploader.upload('https://placekitten.com/96/139')
 ```
-Keep in mind that providing invalid URL
-will raise `ArgumentError`.
 
-### Uploading multiple files
-
-Uploading multiple files is as simple as passing an array
-of `File` instances into our API.
+There are explicit ways to select upload type:
 
 ```ruby
-file1 = File.open("path/to/your/file.png")
-file2 = File.open("path/to/your/another-file.png")
-files = [file1, file2]
-
-@uc_files = @api.upload files
-# => [#<Uploadcare::Api::File uuid="dc99200d-9bd6-4b43-bfa9-aa7bfaefca40">,
-#     #<Uploadcare::Api::File uuid="96cdc400-adc3-435b-9c94-04cd87633fbb">]
-```
-
-In case of multiple input, the respective output would also be an array.
-You can iterate through the array to address to single files.
-You might also want to request more info about a file using `load_data`.
+files = [File.open('1.jpg'), File.open('1.jpg']
+Uploadcare::Uploader.upload_files(files)
 
-```ruby
-@uc_files[0]
-# => #<Uploadcare::Api::File uuid="dc99200d-9bd6-4b43-bfa9-aa7bfaefca40">
+Uploadcare::Uploader.upload_from_url('https://placekitten.com/96/139')
 
-@uc_files[1].load_data
-# => #<Uploadcare::Api::File uuid="96cdc400-adc3-435b-9c94-04cd87633fbb", original_file_url="https://ucarecdn.com/96cdc400-adc3-435b-9c94-04cd87633fbb/samuelzeller118195.jpg", image_info={"width"=>4896, "geo_location"=>nil, "datetime_original"=>nil, "height"=>3264}, ....>
+# multipart upload - can be useful for files bigger than 10 mb
+Uploadcare::Uploader.multipart_upload(File.open('big_file.bin'))
 ```
 
-### `File` object
+### Upload options
 
-Now that we've already outlined using arrays of `File` instances
-to upload multiple files, let's fix on the `File` itself.
-It's the the primary object for Uploadcare API.
-Basically, it's an avatar for a file you uploaded.
-And all the further operations are performed using this avatar,
-the `File` object.
+You can override global [`:autostore`](#initialization) option for each upload request:
 
 ```ruby
-@file_to_upload = File.open("your-file.png")
-
-@uc_file = @api.upload(@file_to_upload)
-# => #<Uploadcare::Api::File ...
-
-@uc_file.uuid
-# => "dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
-
-@uc_file.cdn_url
-# => "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/"
+@api.upload(files, store: true)
+@api.upload_from_url(url, store: :auto)
 ```
 
-Please note, all the data associated with files is only accessible
-through separate HTTP requests only. So if you don't specifically
-need file data (filenames, image dimensions, etc.), you'll be just
-fine with using `:uuid` and `:cdn_url` methods for file output:
-
-```erb
-<img src="#{@file.cdn_url}"/>
-```
-
-Great, we've just lowered a precious loading time.
-However, if you do need the data, you can always request
-it manually:
-
+### Api
+Most methods are also available through `Uploadcare::Api` object:
 ```ruby
-@uc_file.load_data
+# Same as Uploadcare::Uploader.upload
+Uploadcare::Api.upload('https://placekitten.com/96/139')
 ```
 
-That way your file object will respond to any method described
-in [API docs](https://uploadcare.com/documentation/rest/#file).
-Basically, that's an an OpenStruct, so you know what to do:
+### Entity object
 
-```ruby
-@uc_file.original_filename
-# => "logo.png"
-
-@uc_file.image_info
-# => {"width"=>397, "geo_location"=>nil, "datetime_original"=>nil, "height"=>81}
-```
+Entities are representations of objects in Uploadcare cloud.
 
-### `File` object from UUID or CDN URL
+#### File
 
-`File` objects are needed to manipulate files on our CDN.
-The usual case would be you as a client storing file UUIDs
-or CDN URLs somewhere on your side, e.g. in a database.
-This is how you can use those to create `File` objects:
+File entity contains its metadata.
 
 ```ruby
-# file object from UUID
-@file = @api.file "dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
-# => #<Uploadcare::Api::File uuid="dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
-
-# file object from CDN URL
-@file = @api.file "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/"
-# => #<Uploadcare::Api::File uuid="dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
-
-# note, files you generate won't be loaded on init,
-# you'll need to load those manually
-@file.is_loaded?
-# => false
-```
-
-### Operations
-
-Another way to mainpulate files on CDN is through operations.
-This is particularly useful for images.
-We've got on-the-fly crop, resize, rotation, format conversions, and
-[more](https://uploadcare.com/documentation/cdn/).
-Image operations are there to help you build responsive designs,
-generate thumbnails and galleries, change formats, etc.
-Currently, this gem has no specific methods for image operations,
-we're planning to implement those in further versions.
-However, we do support applying image operations through
-adding them to CDN URLs. That's an Uploadcare CDN-native
-way described in our [docs](https://uploadcare.com/documentation/cdn/).
+@file = Uploadcare::File.file('FILE_ID_IN_YOUR_PROJECT')
+{"datetime_removed"=>nil,
+ "datetime_stored"=>"2020-01-16T15:03:15.315064Z",
+ "datetime_uploaded"=>"2020-01-16T15:03:14.676902Z",
+ "image_info"=>
+  {"color_mode"=>"RGB",
+   "orientation"=>nil,
+   "format"=>"JPEG",
+   "sequence"=>false,
+   "height"=>183,
+   "width"=>190,
+   "geo_location"=>nil,
+   "datetime_original"=>nil,
+   "dpi"=>nil},
+ "is_image"=>true,
+ "is_ready"=>true,
+ "mime_type"=>"image/jpeg",
+ "original_file_url"=>
+  "https://ucarecdn.com/FILE_ID_IN_YOUR_PROJECT/imagepng.jpeg",
+ "original_filename"=>"image.png.jpeg",
+ "size"=>5345,
+ "url"=>
+  "https://api.uploadcare.com/files/FILE_ID_IN_YOUR_PROJECT/",
+ "uuid"=>"8f64f313-e6b1-4731-96c0-6751f1e7a50a"}
+
+@file.store # stores file, returns updated metadata
+
+@file.delete #deletes file. Returns updated metadata
+```
+
+Metadata of deleted files is stored permanently.
+
+#### FileList
+
+`Uploadcare::Entity::FileList` represents the whole collection of files (or it's
+subset) and provides a way to iterate through it, making pagination transparent.
+FileList objects can be created using `Uploadcare::Entity.file_list` method.
 
 ```ruby
-@file = @api.file "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/-/crop/150x150/center/-/format/png/"
-# => #<Uploadcare::Api::File uuid="dc99200d-9bd6-4b43-bfa9-aa7bfaefca40"
-
-@file.operations
-# => ["crop/150x150/center", "format/png"]
-
-# note that by default :cdn_url method returns URLs with no operations:
-@file.cdn_url
-# => "https://ucarecdn.com/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/""
-
-# you can pass "true" into the :cdn_url method to get URL including operations:
-@file.cdn_url(true)
-# => "https://ucarecdn.com/a8775cf7-0c2c-44fa-b071-4dd48637ecac/-/crop/150x150/center/-/format/png/"
+@list = Uploadcare::Entity.file_list
+# Returns instance of Uploadcare::Api::FileList
+<Hashie::Mash
+  next=nil
+  per_page=100
+  previous=nil
+  results=[
+    # Array of Entity::File
+  ]
+  total=8>
+# load last page of files
+@files = @list.files
+# load all files
+@all_files = @list.load
+```
+
+This method accepts some options to controll which files should be fetched and
+how they should be fetched:
+
+- **:limit** — Controls page size. Accepts values from 1 to 1000, defaults to 100.
+- **:stored** — Can be either `true` or `false`. When true, file list will contain only stored files. When false — only not stored.
+- **:removed** — Can be either `true` or `false`. When true, file list will contain only removed files. When false — all except removed. Defaults to false.
+- **:ordering** — Controls the order of returned files. Available values: `datetime_updated`, `-datetime_updated`, `size`, `-size`. Defaults to `datetime_uploaded`. More info can be found [here](https://uploadcare.com/documentation/rest/#file-files/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby).
+- **:from** — Specifies the starting point for a collection. Resulting collection will contain files from the given value and to the end in a direction set by an **ordering** option. When files are ordered by `datetime_updated` in any direction, accepts either a `DateTime` object or an ISO 8601 string. When files are ordered by size, accepts non-negative integers (size in bytes). More info can be found [here](https://uploadcare.com/documentation/rest/#file-files/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby).
+
+Options used to create a file list can be accessed through `#options` method.
+Note that, once set, they don't affect file fetching process anymore and are
+stored just for your convenience. That is why they are frozen.
 
-# there also are specific methods to either dump or include image operations
-# in the output URL:
-@file.cdn_url_with_operations
-@file.cdn_url_without_operations
+```ruby
+options = {
+  limit: 10,
+  stored: true,
+  ordering: '-datetime_uploaded',
+  from: "2017-01-01T00:00:00",
+}
+@list = @api.file_list(options)
 ```
 
-While there's no operation wrapper, the best way of handling operations
-is through adding them to URLs as strings:
-
+To simply get all associated objects:
 ```ruby
-<img src="#{file.cdn_url}-/crop/#{width}x#{height}/center/"/>
-# or something like that
+@list.all # => returns Array of Files
 ```
 
-### Copying files
-
-You can also create file copies using our API.
-There are multiple ways of creating those.
-Also, copying is important for image files because
-it allows you to “apply” all the CDN operations
-specified in the source URL to a separate static image.
-
-First of all, a copy of your file can be put in the Uploadcare storage.
-This is called “internal copy”, and here's how it works:
+##### Pagination
 
+Initially, `FileList` is a paginated collection. It can be navigated using following methods:
 ```ruby
-@uc_file.internal_copy
-
-# =>
-{
-  "type"=>"file",
-  "result"=> {
-    "uuid"=>"a191a3df-2c43-4939-9590-784aa371ad6d",
-    "original_file_url"=>"https://ucarecdn.com/a191a3df-2c43-4939-9590-784aa371ad6d/19xldj.jpg",
-    "image_info"=>nil,
-    "datetime_stored"=>nil,
-    "mime_type"=>"application/octet-stream",
-    "is_ready"=>true,
-    "url"=>"https://api.uploadcare.com/files/a191a3df-2c43-4939-9590-784aa371ad6d/",
-    "original_filename"=>"19xldj.jpg",
-    "datetime_uploaded"=>"2017-02-10T14:14:18.690581Z",
-    "size"=>0,
-    "is_image"=>nil,
-    "datetime_removed"=>nil,
-    "source"=>"/4ea293d5-153f-422f-a24e-350237109606/"
-  }
-}
+  @file_list = Uploadcare::Entity::FileList.file_list
+  # Let's assume there are 250 files in cloud. By default, UC loads 100 files. To get next 100 files, do:
+  @next_page = @file_list.next_page
+  # To get previous page:
+  @previous_page = @next_page.previous_page
 ```
 
-Once the procedure is complete, a copy would be a separate file
-with its own UUID and attributes.
-
-`#internal_copy` can optionally be used with the options hash argument.
-The available options are:
-
-- *store*
-
-  By default a copy is created without “storing”.
-  Which means it will be deleted within a 24-hour period.
-  You can make your output copy permanent by passing the
-  `store: true` option to the `#internal_copy` method.
-
-  Example:
-
-  ```ruby
-  @uc_file.internal_copy(store: true)
-  ```
-
-- *strip_operations*
-
-  If your file is an image and you applied some operations to it,
-  then by default the same set of operations is also applied to a copy.
-  You can override this by passing `strip_operations: true` to the
-  `#internal_copy` method.
-
-  Example:
-
-  ```ruby
-  file = @api.file "https://ucarecdn.com/24626d2f-3f23-4464-b190-37115ce7742a/-/resize/50x50/"
-  file.internal_copy
-  # => This will trigger POST /files/ with {"source": "https://ucarecdn.com/24626d2f-3f23-4464-b190-37115ce7742a/-/resize/50x50/"} in the body
-  file.internal_copy(strip_operations: true)
-  # => This will trigger POST /files/ with {"source": "https://ucarecdn.com/24626d2f-3f23-4464-b190-37115ce7742a/"} in the body
-  ```
-
-Another option is copying your file to a custom storage.
-We call it “external copy” and here's the usage example:
-
+Alternatively, it's possible to iterate through full list of groups or files with `each`:
 ```ruby
-@uc_file.external_copy('my_custom_storage_name')
-
-# => 
-{
-  "type"=>"url",
-  "result"=>"s3://my_bucket_name/c969be02-9925-4a7e-aa6d-b0730368791c/view.png"
-}
+@list.each do |file|
+  p file.url
+end
 ```
 
-First argument of the `#external_copy` method is a name of
-a custom destination storage for your file.
-
-There's also an optional second argument — options hash. The available options are:
-
-  - *make_public*
+#### Group
 
-  Make a copy available via public links. Can be either `true` or `false`.
-
-  - *pattern*
-
-  Name pattern for a copy. If the parameter is omitted, custom storage pattern is used.
-
-  - *strip_operations*
-
-  Same as for `#internal_copy`
-
-You might want to learn more about
-[storage options](https://uploadcare.com/documentation/storages/) or
-[copying files](https://uploadcare.com/documentation/rest/#files-post)
-with Uploadcare. 
-
-### `Group` object
-
-Groups are structures intended to organize sets of separate files.
-Each group is assigned UUID.
-Note, group UUIDs include a `~#{files_count}` part at the end.
+Groups are structures intended to organize sets of separate files. Each group is
+assigned UUID. Note, group UUIDs include a `~#{files_count}` part at the end.
 That's a requirement of our API.
 
 ```ruby
 # group can be created from an array of Uploadcare files
 @files_ary = [@file, @file2]
-@files = @api.upload @files_ary
-@group = @api.create_group @files
-# => #<Uploadcare::Api::Group uuid="0d192d66-c7a6-4465-b2cd-46716c5e3df3~2", files_count=2 ...
-
-# another way to from a group is via an array of strings holding UUIDs
-@uuids_ary = ["c969be02-9925-4a7e-aa6d-b0730368791c", "c969be02-9925-4a7e-aa6d-b0730368791c"]
-@group = @api.create_group @uuids_ary
-# => #<Uploadcare::Api::Group uuid="0d192d66-c7a6-4465-b2cd-46716c5e3df3~2", files_count=2 ...
-
-# also, you can create a group object via group UUID
-@group_uloaded = @api.group "#{uuid}"
+@files = Uploadcare::Uploader.upload @files_ary
+@group = Uploadcare::Group.create @files
 ```
 
-As with files, groups created via UUIDs are not loaded by default.
-You need to load the data manually, as it requires a separate
-HTTP GET request. New groups created with the `:create_group` method
-are loaded by default.
+#### GroupList
+`GroupList` is a list of `Group`
 
 ```ruby
-@group = @api.group "#{uuid}"
-
-@group.is_loaded?
-# => false
-
-@group.load_data
-# => #<Uploadcare::Api::Group uuid="0d192d66-c7a6-4465-b2cd-46716c5e3df3~2", files_count=2 ...
-
-# once a group is loaded, you can use any methods described in our API docs
-# the files within a loaded group are loaded by default
-@group.files
-# => [#<Uploadcare::Api::File uuid="24626d2f-3f23-4464-b190-37115ce7742a" ...>,
-#       ... #{files_count} of them ...
-#     #<Uploadcare::Api::File uuid="7bb9efa4-05c0-4f36-b0ef-11a4221867f6" ...>]
+@group_list = Uploadcare::GroupList.list
+# To get an array of groups:
+@groups = @group_list.all
 ```
 
-Check out our docs to learn more about
-[groups](https://uploadcare.com/documentation/rest/#group).
-
-### File lists and pagination
-
-File list is a paginated collection of files. Such lists are created
-to better represent the contents of your project.
-For this gem, a file list would be a single page containing
-20 files (you can override the number).
-There also are methods for navigating through pages.
-You can find more info about pagination
-[here](https://uploadcare.com/documentation/rest/#pagination).
-
-```ruby
-@list = @api.file_list 1 # page number, 1 is the default
-# => #<Uploadcare::Api::FileList ....
-
-
-# method :results returns an array of files
-@list.results
-# => [#<Uploadcare::Api::File uuid="24626d2f-3f23-4464-b190-37115ce7742a" ...>,
-#       ... 20 of them ...
-#     #<Uploadcare::Api::File uuid="7bb9efa4-05c0-4f36-b0ef-11a4221867f6" ...>]
+This is a paginated list, so [pagination](#Pagination) methods apply
 
+#### Webhook
+https://uploadcare.com/docs/api_reference/rest/webhooks/
 
-# note, every file is already loaded
-@list.results[1].is_loaded?
-# => true
-
-
-# we've also added some shortcuts
-@list.to_a
-# => [#<Uploadcare::Api::File uuid="24626d2f-3f23-4464-b190-37115ce7742a" ...>,
-#       ... 20 of them ...
-#     #<Uploadcare::Api::File uuid="7bb9efa4-05c0-4f36-b0ef-11a4221867f6" ...>]
-
-@list[3]
-# => #<Uploadcare::Api::File ....
-```
-
-Here's how we handle navigating through pages:
+You can use webhooks to provide notifications about your uploads to target urls.
+This gem lets you create and manage webhooks.
 
 ```ruby
-@list = @api.files_list 3
-
-@list.next_page
-# => #<Uploadcare::Api::FileList page=4 ....
-
-@list.previous_page
-# => #<Uploadcare::Api::FileList page=2 ....
-
-@list.go_to 5
-# => #<Uploadcare::Api::FileList page=5 ....
-
-# of course, you can go with any of the methods
-# described in our API docs
-# total pages
-@list.pages
-# => 16
-
-# current page
-@list.page
-# => 3
-
-# files per page
-@list.per_page
-# => 20
-
-# total files in a project
-@list.total
-# => 308
+Uploadcare::Webhook.create('example.com/listen', event: 'file.uploaded')
 ```
 
-### `Project` object
+#### Project
 
-`Project` provides basic info about the connected Uploadcare project.
-That object is also an OpenStruct, so every methods out of
-[these](https://uploadcare.com/documentation/rest/#project) will work.
+`Project` provides basic info about the connected Uploadcare project. That
+object is also an Hashie::Mash, so every methods out of
+[these](https://uploadcare.com/documentation/rest/#project/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby) will work.
 
 ```ruby
-project = @api.project
+@project = Uploadcare::Project.project
 # => #<Uploadcare::Api::Project collaborators=[], name="demo", pub_key="demopublickey", autostore_enabled=true>
 
-project.name
+@project.name
 # => "demo"
 
-p.collaborators
+@project.collaborators
 # => []
 # while that one was empty, it usually goes like this:
 # [{"email": collaborator@gmail.com, "name": "Collaborator"}, {"email": collaborator@gmail.com, "name": "Collaborator"}]
 ```
 
-### Raw API
-
-Raw API is a simple interface allowing you to make
-custom requests to Uploadcare REST API.
-It's mainly used when you want a low-level control
-over your app.
-
-```ruby
-# here's how you make any requests
-@api.request :get, "/files/", {page: 2}
-
-# and there also are shortcuts for methods
-@api.get '/files', {page: 2}
-
-@api.post ...
-
-@api.put ...
-
-@api.delete ...
-
-```
-
-All of the raw API methods return a parsed JSON response
-or raise an error (handling those is done on your side in the case).
-
-### Error handling
-
-Starting from the version 1.0.2, we've got have custom exceptions
-that will be raised in case the Uploadcare service returns
-something with 4xx or 5xx HTTP status.
-
-Check out the list of custom errors:
-
-```ruby
-400 => Uploadcare::Error::RequestError::BadRequest,
-401 => Uploadcare::Error::RequestError::Unauthorized,
-403 => Uploadcare::Error::RequestError::Forbidden,
-404 => Uploadcare::Error::RequestError::NotFound,
-406 => Uploadcare::Error::RequestError::NotAcceptable,
-408 => Uploadcare::Error::RequestError::RequestTimeout,
-422 => Uploadcare::Error::RequestError::UnprocessableEntity,
-429 => Uploadcare::Error::RequestError::TooManyRequests,
-500 => Uploadcare::Error::ServerError::InternalServerError,
-502 => Uploadcare::Error::ServerError::BadGateway,
-503 => Uploadcare::Error::ServerError::ServiceUnavailable,
-504 => Uploadcare::Error::ServerError::GatewayTimeout
-```
-
-That's how you handle a particular error
-(in this case, a “404: Not Found” error):
-
-```ruby
-begin
-  @connection.send :get, '/random_url/', {}
-rescue Uploadcare::Error::RequestError::NotFound => e
-  nil
-end
-```
-
-Handling any request error (covers all 4xx status codes): 
-
-```ruby
-begin
-  @connection.send :get, '/random_url/', {}
-rescue Uploadcare::Error::RequestError => e
-  nil
-end
-```
-
-Handling any Uploadcare service error:
-
-```ruby
-begin
-  @connection.send :get, '/random_url/', {}
-rescue Uploadcare::Error => e
-  nil
-end
-```
-
-Since many of the above listed things depend on Uploadcare servers,
-errors might occasionally occur. Be prepared to handle those.
-
-## Testing
-
-For testing purposes, run `bundle exec rspec`.
-
-Please note, if you're willing to run tests using your own keys,
-make a `spec/config.yml` file containing the following:
-
-```yaml
-public_key: 'PUBLIC KEY'
-private_key: 'PRIVATE KEY'
-```
-
-## Contributors
-
-This is open source so fork, hack, request a pull — get a discount.
-
-- [@romanonthego](https://github.com/romanonthego)
-- [@vizvamitra](https://github.com/vizvamitra)
-- [@dmitry-mukhin](https://github.com/dmitry-mukhin)
-- [@zenati](https://github.com/zenati)
-- [@renius](https://github.com/renius)
-
-## Security issues
-
-If you think you ran into something in Uploadcare libraries
-which might have security implications, please hit us up at
-[bugbounty@uploadcare.com](mailto:bugbounty@uploadcare.com)
-or Hackerone.
+## Useful links
 
-We'll contact you personally in a short time to fix an issue
-through co-op and prior to any public disclosure.
+* [Development](https://github.com/uploadcare/uploadcare-ruby/blob/main/DEVELOPMENT.md)
+* [Uploadcare documentation](https://uploadcare.com/docs/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)  
+* [Upload API reference](https://uploadcare.com/api-refs/upload-api/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)  
+* [REST API reference](https://uploadcare.com/api-refs/rest-api/?utm_source=github&utm_medium=referral&utm_campaign=uploadcare-ruby)  
+* [Changelog](./CHANGELOG.md)  
+* [Contributing guide](https://github.com/uploadcare/.github/blob/master/CONTRIBUTING.md)  
+* [Security policy](https://github.com/uploadcare/uploadcare-ruby/security/policy)  
+* [Support](https://github.com/uploadcare/.github/blob/master/SUPPORT.md)