unsplash 1.5.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2baf82aec25861dec27432935378a12e49344a1920e8c6d2a0f3972cf80ae275
-  data.tar.gz: 6964813d9ed8b4bf69122900ed31c6e498cac94ab2748f33f7277086772ea42d
+  metadata.gz: d581307faeeb1e5d04567b3f78448e7cb78d461a0f1a5d5fc4df9b1fcb956fbb
+  data.tar.gz: e1f9433a95e64812f5f987e826a3e590a66c16f89932ccb4f2c1c4b31465fbc0
 SHA512:
-  metadata.gz: 241302c561d0633f1403c483e3fb787dfe1a13319bdf868dc65fe55c17ab9d170adb4d28473a29b1e4ef6ed71ac5d6098a5cde69249d65c9f4ef3546ba3a2b32
-  data.tar.gz: eaa1640eccffbe19204a2c5a959d3a67533819f6879a35e0bda1bb7469e07396eec791abd4ddb2ca05981849935adfe881e209ef4882aa4e7d14bedc33f2d83c
+  metadata.gz: df3a61dfe8ce5343708ec01727ba70270e3795aa61465a93b56e4a75f0ef2c44800c8ac32f2c9ec255a4a7f5e825c597f1528f47f1a976c91d264f60f69cd5f5
+  data.tar.gz: 1da020da45c5f45baf522da57fa6cb2ed2a7d36ab32e436f0ab3ab1d2f26f5ddbd5ca2edbc8aca660f099ee319d3ee53b9143b993eddf71d3d117a5ddca18677

data/.gitignore

@@ -7,4 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-.idea/
+.idea/
+
+config.env

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.0
+ruby-2.5.3

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.1
-  - 2.4.0
-before_install: gem install bundler -v 1.10.2
+  - 2.3.8
+  - 2.4.5
+  - 2.5.4
+  - 2.6.2
+before_install: gem install bundler

data/README.md

@@ -34,14 +34,17 @@ Unsplash.configure do |config|
   config.application_secret = "YOUR APPLICATION SECRET"
   config.application_redirect_uri = "https://your-application.com/oauth/callback"
   config.utm_source = "alices_terrific_client_app"
+
+  # optional:
+  config.logger = MyCustomLogger.new
 end
 ```
 
 #### API Guidelines
 
-All API applications must abide by the [API Guidelines](https://medium.com/unsplash/unsplash-api-guidelines-28e0216e6daa).
+All API applications must abide by the [API Guidelines](https://help.unsplash.com/api-guidelines/unsplash-api-guidelines).
 
-As part of [the API guidelines](https://medium.com/unsplash/unsplash-api-guidelines-28e0216e6daa), all API uses are required to use utm links when providing credit to photographers and Unsplash. Set the `config.utm_source` to your app's name to automatically append the utm source.
+As part of [the API guidelines](https://help.unsplash.com/api-guidelines/unsplash-api-guidelines), all API uses are required to use utm links when providing credit to photographers and Unsplash. Set the `config.utm_source` to your app's name to automatically append the utm source.
 
 ### Public-scope actions
 
@@ -83,7 +86,7 @@ permission scopes you requested and the user authorized.
 
 ### Hotlinking
 
-Hotlinking the [Unsplash image files is required](https://medium.com/@lukechesser/unsplash-api-guidelines-hotlinking-images-6c6b51030d2a)
+Hotlinking the [Unsplash image files is required](https://help.unsplash.com/api-guidelines/more-on-each-guideline/guideline-hotlinking-images)
 
 Unlike most APIs, Unsplash requires for the image URLs returned by the API to be directly used or embedded in your applications (generally referred to as hotlinking). By using the CDN and embedding the photo URLs in your application, Unsplash can better track photo views and pass those stats on to the photographer, providing them with context for how popular their photo is and how it's being used.
 

data/config.env.example

@@ -0,0 +1,5 @@
+UNSPLASH_ACCESS_KEY=abc123
+UNSPLASH_SECRET_KEY=def456
+UNSPLASH_BEARER_TOKEN=ghi789
+UNSPLASH_API_URI=https://api.unsplash.com/
+UNSPLASH_OAUTH_URI=https://unsplash.com/

data/lib/unsplash.rb

@@ -9,8 +9,6 @@ require "unsplash/client"
 require "unsplash/connection"
 require "unsplash/user"
 require "unsplash/photo"
-require "unsplash/category"
-require "unsplash/curated_batch"
 require "unsplash/collection"
 require "unsplash/stats"
 require "unsplash/search"

data/lib/unsplash/collection.rb

@@ -8,9 +8,8 @@ module Unsplash # :nodoc:
       # Get a specific collection.
       # @param id [Integer] The ID of the collection.
       # @return [Unsplash::Collection] The requested collection.
-      def find(id, curated = false)
-        url = ["/collections", (curated ? "curated" : nil), id].compact.join("/")
-        Unsplash::Collection.new JSON.parse(connection.get(url).body)
+      def find(id)
+        Unsplash::Collection.new JSON.parse(connection.get("/collections/#{id}").body)
       end
 
       # Get a list of all collections.
@@ -40,19 +39,6 @@ module Unsplash # :nodoc:
         list.map { |data| Unsplash::Collection.new(data) }
       end
 
-      # Get a list of all curated collections.
-      # @param page [Integer] Which page of search results to return.
-      # @param per_page [Integer] The number of search results per page. (default: 10, maximum: 30)
-      # @return [Array] A single page of the +Unsplash::Collection+ list.
-      def curated(page = 1, per_page = 10)
-        params = {
-          page:     page,
-          per_page: per_page
-        }
-        list = JSON.parse(connection.get("/collections/curated", params).body)
-        list.map { |data| Unsplash::Collection.new(data) }
-      end
-
       # Create a new collection on behalf of current user.
       # @param title [String] The title of the collection.
       # @param description [String] The collection's description. (optional)

data/lib/unsplash/configuration.rb

@@ -15,15 +15,5 @@ module Unsplash # :nodoc:
     def test?
       !!@test
     end
-
-    def application_id=(key)
-      logger.warn "Configuring application_id is deprecated. Use application_access_key."
-      self.application_access_key = key
-    end
-
-    def application_id
-      application_access_key
-    end
-
   end
 end

data/lib/unsplash/connection.rb

@@ -62,9 +62,8 @@ module Unsplash #:nodoc:
     # @param token_extract [Hash] OAuth token hash from #extract_token.
     # @return [OAuth2::AccessToken, nil] New access token object.
     def create_and_assign_token(token_extract)
-      unless token_extract.nil?
-        @oauth_token = OAuth2::AccessToken.from_hash(@oauth, token_extract)
-      end
+      return if !token_extract
+      @oauth_token = OAuth2::AccessToken.from_hash(@oauth, token_extract)
     end
 
     # Perform a GET request.
@@ -112,13 +111,17 @@ module Unsplash #:nodoc:
         # Anything else? User agent?
       }
 
-      response = if @oauth_token
-        refresh_token!
+      response = begin
+        if @oauth_token
+          refresh_token!
 
-        param_key = verb == :post ? :body : :params
-        @oauth_token.public_send(verb,  @api_base_uri + path, param_key => params, headers: headers)
-      else
-        self.class.public_send verb, path, query: params, headers: public_auth_header
+          param_key = verb == :post ? :body : :params
+          @oauth_token.public_send(verb,  @api_base_uri + path, param_key => params, headers: headers)
+        else
+          self.class.public_send verb, path, query: params, headers: public_auth_header
+        end
+      rescue OAuth2::Error => e
+        OpenStruct.new(headers: {}, status: 403, body: e.error_message(e.response.body))
       end
 
       if response.headers["Warning"]
@@ -127,14 +130,17 @@ module Unsplash #:nodoc:
 
       status_code = response.respond_to?(:status) ? response.status : response.code
 
-      begin
-        if !(200..299).include?(status_code)
-          body = JSON.parse(response.body)
-          msg = body["error"] || body["errors"].join(" ")
-          raise Unsplash::Error.new msg
-        end
-      rescue JSON::ParserError
-        raise Unsplash::Error.new response.body
+      case status_code
+      when 200..299
+        response
+      when 401
+        raise Unsplash::UnauthorizedError.new(error_message(response))
+      when 403
+        raise Unsplash::ForbiddenError.new(error_message(response))
+      when 404
+        raise Unsplash::NotFoundError.new(error_message(response))
+      else
+        raise Unsplash::Error.new(error_message(response))
       end
 
       response
@@ -157,5 +163,12 @@ module Unsplash #:nodoc:
 
       @oauth_token = @oauth_token.refresh_token
     end
+
+    def error_message(response)
+      body = JSON.parse(response.body)
+      body["error"] || body["errors"].join(" ")
+    rescue JSON::ParserError
+      raise Unsplash::Error.new(response.body)
+    end
   end
 end

data/lib/unsplash/errors.rb

@@ -3,4 +3,8 @@ module Unsplash # :nodoc:
   class Error < StandardError; end
   # Raise for deprecation errors
   class DeprecationError < Error; end
+
+  class UnauthorizedError < Error; end
+  class ForbiddenError < Error; end
+  class NotFoundError < Error; end
 end

data/lib/unsplash/photo.rb

@@ -17,9 +17,9 @@ module Unsplash # :nodoc:
       true
     end
 
-    # Download a photo.
+    # Track the download of a photo.
     # @return [String] URL of image file for download.
-    def download!
+    def track_download
       connection.get(links.download_location)["url"]
     end
 
@@ -27,17 +27,9 @@ module Unsplash # :nodoc:
 
       # Get a photo. Can be cropped or resized using the optional parameters.
       # @param id [String] The ID of the photo to retrieve.
-      # @param width [Integer] Width of customized version of the photo.
-      # @param height [Integer] Height of the customized version of the photo.
-      # @param crop_rect [String] A comma-separated list (x,y,width,height) of the rectangle to crop from the photo.
       # @return [Unsplash::Photo] The Unsplash Photo.
-      def find(id, width: nil, height: nil, crop_rect: nil)
-        custom = {
-          w:    width,
-          h:    height,
-          rect: crop_rect
-        }.select { |k,v| v }
-        photo = Unsplash::Photo.new JSON.parse(connection.get("/photos/#{id}", custom).body)
+      def find(id)
+        photo = Unsplash::Photo.new JSON.parse(connection.get("/photos/#{id}").body)
         photo.user = Unsplash::User.new photo.user
         photo
       end
@@ -45,24 +37,18 @@ module Unsplash # :nodoc:
       # Get a random photo or set of photos. The photo selection pool can be narrowed using
       # a combination of optional parameters. Can also optionally specify a custom image size.
       # @param count [Integer] Number of photos required. Default=1, Max=30
-      # @param categories [Array] Limit selection to given category ID's.
       # @param featured [Boolean] Limit selection to featured photos.
       # @param user [String] Limit selection to given User's ID.
       # @param query [String] Limit selection to given search query.
-      # @param width [Integer] Width of customized version of the photo.
-      # @param height [Integer] Height of the customized version of the photo.
       # @param orientation [String] Filter by orientation of the photo. Valid values are landscape, portrait, and squarish.
       # @return [Unsplash::Photo] An Unsplash Photo if count parameter is omitted
       # @return [Array] An array of Unsplash Photos if the count parameter is specified. An array is returned even if count is 1
-      def random(count: nil, categories: nil, collections: nil, featured: nil, user: nil, query: nil, width: nil, height: nil, orientation: nil)
+      def random(count: nil, collections: nil, featured: nil, user: nil, query: nil, orientation: nil)
         params = {
-          category: (categories && categories.join(",")),
           collections: (collections && collections.join(",")),
           featured: featured,
           username: user,
           query:    query,
-          w:        width,
-          h:        height,
           orientation: orientation
         }.select { |k,v| v }
         if count
@@ -109,28 +95,6 @@ module Unsplash # :nodoc:
         parse_list connection.get("/photos/", params).body
       end
 
-      # Get a single page from the list of the curated photos (front-page’s photos).
-      # @param page [Integer] Which page of search results to return.
-      # @param per_page [Integer] The number of search results per page. (default: 10, maximum: 30)
-      # @param order_by [String] How to sort the photos. (Valid values: latest, oldest, popular; default: latest)
-      # @return [Array] A single page of +Unsplash::Photo+ search results.
-      def curated(page = 1, per_page = 10, order_by = "latest")
-        params = {
-          page:     page,
-          per_page: per_page,
-          order_by: order_by
-        }
-        parse_list connection.get("/photos/curated", params).body
-      end
-
-      # Upload a photo on behalf of the current user.
-      # @param filepath [String] The local path of the image file to upload.
-      # @return [Unsplash::Photo] The uploaded photo.
-      # <b>DEPRECATED</b>
-      def create(filepath)
-        raise Unsplash::DeprecationError.new "API photo-upload endpoint has been deprecated and removed."
-      end
-
       private
 
       def parse_list(json)

data/lib/unsplash/version.rb

@@ -1,4 +1,4 @@
 module Unsplash # :nodoc:
   # :nodoc:
-  VERSION = "1.5.6"
+  VERSION = "2.0.0"
 end

data/unsplash.gemspec

@@ -18,16 +18,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_dependency "httparty", "~> 0.14.0"
+  spec.add_dependency "httparty", "~> 0.16.4"
   spec.add_dependency "oauth2",   "~> 1"
 
-  # spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake",    "~> 12.0"
-  spec.add_development_dependency "rspec",   "~> 3.5.0"
+  spec.add_development_dependency "rake",    "~> 12.3.2"
+  spec.add_development_dependency "rspec",   "~> 3.8.0"
   spec.add_development_dependency "vcr",     "~> 3.0.0"
-  spec.add_development_dependency "webmock", "~> 2.3.0"
+  spec.add_development_dependency "webmock", "~> 3.5.1"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "coveralls", '~> 0.8.17'
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "rb-readline"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unsplash
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Aaron Klaassen
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.16.4
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 12.3.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 3.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +112,44 @@ dependencies:
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.17
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.17
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - aaron@unsplash.com
@@ -144,13 +172,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config.env.example
 - lib/unsplash.rb
-- lib/unsplash/category.rb
 - lib/unsplash/client.rb
 - lib/unsplash/collection.rb
 - lib/unsplash/configuration.rb
 - lib/unsplash/connection.rb
-- lib/unsplash/curated_batch.rb
 - lib/unsplash/errors.rb
 - lib/unsplash/photo.rb
 - lib/unsplash/search.rb
@@ -170,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/unsplash/category.rb

@@ -1,33 +0,0 @@
-module Unsplash # :nodoc:
-
-  # Unsplash Category operations.
-  class Category < Client
-
-    class << self
-
-      # Get a list of all of the Unsplash photo categories.
-      # @return [Array] The list categories.
-      # <b>DEPRECATED</b>
-      def all
-        raise Unsplash::DeprecationError.new "Category has been deprecated and removed."
-      end
-
-      # Get an Unsplash Category.
-      # @param id [Integer] The ID of the category to retrieve.
-      # @return [Unsplash::Category] The specified category.
-      # <b>DEPRECATED</b>
-      def find(id)
-        raise Unsplash::DeprecationError.new "Category has been deprecated and removed."
-      end
-    end
-
-    # Get a list of all photos in this category.
-    # @param page  [Integer] Which page of search results to return.
-    # @param per_page [Integer] The number of search results per page. 
-    # @return [Array] A single page of +Unsplash::Photo+s.
-    # <b>DEPRECATED</b>
-    def photos(page = 1, per_page = 10)
-      raise Unsplash::DeprecationError.new "Category has been deprecated and removed."
-    end
-  end
-end

data/lib/unsplash/curated_batch.rb

@@ -1,43 +0,0 @@
-module Unsplash # :nodoc: 
-
-  # Unsplash Curated Batch operations.
-  class CuratedBatch < Client
-
-    class << self
-
-      # Get a specific curated batch.
-      # @param id [Integer] The ID of the batch.
-      # @return [Unsplash::CuratedBatch] The requested batch.
-      def find(id)
-        batch = Unsplash::CuratedBatch.new JSON.parse(connection.get("/curated_batches/#{id}").body)
-        batch.curator = Unsplash::User.new batch.curator
-        batch
-      end
-
-      # Get a list of all curated batches.
-      # @param page  [Integer] Which page of search results to return.
-      # @param per_page [Integer] The number of search results per page.
-      # @return [Array] A single page of the +Unsplash::CuratedBatch+ list.
-      def all(page = 1, per_page = 10)
-        params = {
-          page:     page,
-          per_page: per_page
-        }
-        list = JSON.parse(connection.get("/curated_batches/", params).body)
-        list.map do |cb|
-          batch = Unsplash::CuratedBatch.new cb
-          batch.curator = Unsplash::User.new batch.curator
-          batch
-        end
-      end
-    end
-
-    # Get a list of the photos contained in this batch.
-    # @return [Array] The list of +Unsplash::Photo+s in the batch.
-    def photos
-      list = JSON.parse(connection.get("/curated_batches/#{id}/photos").body)
-      list.map { |photo| Unsplash::Photo.new photo }
-    end
-
-  end
-end