unsplash 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6883b2d6a8deb3a58d175b12696ab781fd95ba6
-  data.tar.gz: 043df11035a46a1eca2a380d3250f5554bdaf69a
+  metadata.gz: 4e502e452a28e94ceccf4bdcb5adc9d9bef9e630
+  data.tar.gz: 8fe977a313d140877a63ac23fdedeeff0b839be0
 SHA512:
-  metadata.gz: ed50d74a7eeb5c7216d21ec8283a7d20971c48503a395ada073846e4052596d2bedf397aac972d1450abe827ae0994f0ea8996c3ea3b27e71fc45c60b21b289f
-  data.tar.gz: 8135c81774d593a5fcb0b71a5ae90cd43f4a66521f1e88e1f305343fb6567eece3c189549a03e2bdcef9a9e2a1e15e6c6d4e884d38e60c431f38bcf1c841c959
+  metadata.gz: 446d3c4363e234c11d7c6758b050df3363ed33a42dd5b7cc44116550d3d34adc43a4d75178be0295f1517e9675e88bd0d127d7a17005b8f7b2919a2fa233d31d
+  data.tar.gz: c1ae6a56978d8d4c0a7fad854522cf4dbbb944d379a1e5b4209eadec0f12d07c776dc51fa7d715cda938cb0ef1ff0c67b62b70821885fac24610eb22f66a7063

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.6
+ruby-2.3.0

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.5
+  - 2.2.5
+  - 2.3.1
 before_install: gem install bundler -v 1.10.2

data/README.md

@@ -1,6 +1,7 @@
 # unsplash_rb
 
-[ ![Codeship Status for CrewLabs/unsplash_rb](https://codeship.com/projects/0d395ea0-fe45-0132-5e19-022bf5e0402e/status?branch=master)](https://codeship.com/projects/88039)
+[![Build Status](https://travis-ci.org/unsplash/unsplash_rb.svg?branch=travis)](https://travis-ci.org/unsplash/unsplash_rb)
+[![Coverage Status](https://coveralls.io/repos/github/unsplash/unsplash_rb/badge.svg?branch=master&gh_cache_bust=1)](https://coveralls.io/github/unsplash/unsplash_rb?branch=master)
 
 A ruby client for [the Unsplash API](https://unsplash.com/documentation).
 
@@ -37,8 +38,7 @@ end
 
 ### Public-scope actions
 
-If you are *only* making public requests (i.e. nothing requiring a specific logged-in user,
-for example photo uploads or private user details), then you're ready to go!
+If you are *only* making public requests (i.e. nothing requiring a specific logged-in user, for example liking photos or accessing private user details), then you're ready to go!
 
 Looking for details of a specific photo? Find it by ID:
 
@@ -52,7 +52,7 @@ Want a bunch of pictures of cats? You're on the internet; of course you do.
 search_results = Unsplash::Photo.search("cats")
 ```
 
-For a complete list of available actions, see our [documentation details](http://www.rubydoc.info/github/CrewLabs/unsplash_rb).
+For a complete list of available actions, see our [documentation details](http://www.rubydoc.info/github/unsplash/unsplash_rb/).
 
 ### User Authorization
 
@@ -88,7 +88,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/crewlabs/unsplash_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/unsplash/unsplash_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/unsplash/client.rb

@@ -4,7 +4,7 @@ module Unsplash # :nodoc:
   class Client
 
     # Build an Unsplash object with the given attributes.
-    # @param attrs [Hash] 
+    # @param attrs [Hash]
     def initialize(attrs = {})
       @attributes = OpenStruct.new(attrs)
     end
@@ -23,7 +23,8 @@ module Unsplash # :nodoc:
 
     # @private
     def method_missing(method, *args, &block)
-      @attributes.send(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Client.new(attribute) : attribute
     end
 
     # The connection object being used to communicate with Unsplash.
@@ -32,7 +33,7 @@ module Unsplash # :nodoc:
       self.class.connection
     end
 
-    class << self 
+    class << self
       # The connection object being used to communicate with Unsplash.
       # @return [Unsplash::Connection] the connection
       def connection

data/lib/unsplash/collection.rb

@@ -52,6 +52,18 @@ module Unsplash # :nodoc:
         Unsplash::Collection.new JSON.parse(connection.post("/collections", params).body)
       end
 
+      # Get a single page of collection results for a query.
+      # @param query [String] Keywords to search for.
+      # @param page  [Integer] Which page of search results to return.
+      # @return [Array] a list of +Unsplash::Collection+ objects. 
+      def search(query, page = 1)
+        params = {
+          query:    query,
+          page:     page
+        }
+        Unsplash::Search.search("/search/collections", self, params)
+      end
+
     end
 
     def initialize(options = {})
@@ -114,4 +126,4 @@ module Unsplash # :nodoc:
     end
 
   end
-end
+end

data/lib/unsplash/configuration.rb

@@ -3,10 +3,12 @@ module Unsplash # :nodoc:
     attr_accessor :application_id
     attr_accessor :application_secret
     attr_accessor :application_redirect_uri
+    attr_accessor :logger
     attr_writer   :test
 
     def initialize
       @test = true
+      @logger = Logger.new(STDOUT)
     end
 
     def test?

data/lib/unsplash/connection.rb

@@ -93,10 +93,14 @@ module Unsplash #:nodoc:
         param_key = verb == :post ? :body : :params
         @oauth_token.public_send(verb,  @api_base_uri + path, param_key => params, headers: headers)
       
-      else        
+      else
         self.class.public_send verb, path, query: params, headers: public_auth_header
       end
 
+      if response.headers["Warning"]
+        Unsplash.configuration.logger.warn response.headers["Warning"]
+      end
+
       status_code = response.respond_to?(:status) ? response.status : response.code
 
       if !(200..299).include?(status_code)

data/lib/unsplash/photo.rb

@@ -36,16 +36,19 @@ module Unsplash # :nodoc:
         photo
       end
 
-      # Get a random photo. The photo selection pool can be narrowed using
+      # 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.
-      # @return [Unsplash::Photo] An Unsplash Photo.
-      def random(categories: nil, collections: nil, featured: nil, user: nil, query: nil, width: nil, height: nil)
+      # @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)
         params = {
           category: (categories && categories.join(",")),
           collections: (collections && collections.join(",")),
@@ -53,30 +56,37 @@ module Unsplash # :nodoc:
           username: user,
           query:    query,
           w:        width,
-          h:        height
+          h:        height,
+          orientation: orientation
         }.select { |k,v| v }
-
-        photo = Unsplash::Photo.new JSON.parse(connection.get("/photos/random", params).body)
-        photo.user = Unsplash::User.new photo.user
-        photo
+        if count
+          params[:count] = count
+          photos = parse_list connection.get("/photos/random/", params).body
+          photos.map { |photo| 
+            photo.user = Unsplash::User.new photo[:user]
+            photo
+          }
+        else
+          photo = Unsplash::Photo.new JSON.parse(connection.get("/photos/random", params).body)
+          photo.user = Unsplash::User.new photo.user
+          photo
+        end
       end
 
       # Search for photos by keyword.
       # @param query [String] Keywords to search for.
       # @param page  [Integer] Which page of search results to return.
-      # @param per_page [Integer] The number of search results per page.
-      def search(query, page = 1, per_page = 10)
+      def search(query, page = 1)
         params = {
           query:    query,
-          page:     page,
-          per_page: per_page
+          page:     page
         }
-        parse_list connection.get("/photos/search/", params).body
+        Unsplash::Search.search("/search/photos", self, params)
       end
 
       # Get a list of all photos.
       # @param page  [Integer] Which page of search results to return.
-      # @param per_page [Integer] The number of search results per page. 
+      # @param per_page [Integer] The number of search results per page.
       # @return [Array] A single page of +Unsplash::Photo+ search results.
       def all(page = 1, per_page = 10)
         params = {
@@ -86,14 +96,26 @@ 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.
+      # @param order_by [String] How to sort the photos.
+      # @return [Array] A single page of +Unsplash::Photo+ search results.
+      def curated(page = 1, per_page = 10, order_by = "popular")
+        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)
-        file = Faraday::UploadIO.new(filepath, "image/jpeg")
-        photo = Unsplash::Photo.new JSON.parse(connection.post("/photos", photo: file).body)
-        photo.user = Unsplash::User.new photo.user
-        photo
+        raise Unsplash::Error.new "API photo-upload endpoint has been deprecated and removed."
       end
 
       private
@@ -104,4 +126,4 @@ module Unsplash # :nodoc:
 
     end
   end
-end
+end

data/lib/unsplash/search.rb

@@ -0,0 +1,19 @@
+module Unsplash # :nodoc:
+
+  # Unsplash Search operations
+  class Search < Client
+    class << self
+      # Helper class to facilitate search on multiple classes
+      # @param url [String] Url to be searched into
+      # @param klass [Class] Class to instantiate the contents with
+      # @param params [Hash] Params for the search
+      def search(url, klass, params)
+        list = JSON.parse(connection.get(url, params).body)
+
+        list["results"].map do |content|
+          klass.new content.to_hash
+        end
+      end
+    end
+  end
+end

data/lib/unsplash/user.rb

@@ -25,30 +25,63 @@ module Unsplash # nodoc:
         Unsplash::User.new JSON.parse(connection.put("/me", params).body)
       end
 
+      # Get a single page of user results for a query.
+      # @param query [String] Keywords to search for.
+      # @param page  [Integer] Which page of search results to return.
+      # @return [Array] a list of +Unsplash::User+ objects.
+      def search(query, page = 1)
+        params = {
+          query:    query,
+          page:     page
+        }
+        Unsplash::Search.search("/search/users", self, params)
+      end
+
     end
 
     # Get a list of photos uploaded by the user.
-    # @return [Array] a list of +Unsplash::Photo+ objects. 
-    def photos
-      list = JSON.parse(connection.get("/users/#{username}/photos").body)
+    # @param page  [Integer] Which page of results to return.
+    # @param per_page [Integer] The number of results per page.
+    # @return [Array] a list of +Unsplash::Photo+ objects.
+    def photos(page = 1, per_page = 10)
+      params = {
+        page:     page,
+        per_page: per_page
+      }
+
+      list = JSON.parse(connection.get("/users/#{username}/photos", params).body)
       list.map do |photo|
         Unsplash::Photo.new photo.to_hash
       end
     end
 
     # Get a list of photos liked by the user.
-    # @return [Array] a list of +Unsplash::Photo+ objects. 
-    def likes
-      list = JSON.parse(connection.get("/users/#{username}/likes").body)
+    # @param page  [Integer] Which page of results to return.
+    # @param per_page [Integer] The number of results per page.
+    # @return [Array] a list of +Unsplash::Photo+ objects.
+    def likes(page = 1, per_page = 10)
+      params = {
+        page:     page,
+        per_page: per_page
+      }
+
+      list = JSON.parse(connection.get("/users/#{username}/likes", params).body)
       list.map do |photo|
         Unsplash::Photo.new photo.to_hash
       end
     end
 
-    # Get a list of photos liked by the user.
-    # @return [Array] a list of +Unsplash::Collection+ objects. 
-    def collections
-      list = JSON.parse(connection.get("/users/#{username}/collections").body)
+    # Get a list of collections created by the user.
+    # @param page  [Integer] Which page of results to return.
+    # @param per_page [Integer] The number of results per page.
+    # @return [Array] a list of +Unsplash::Collection+ objects.
+    def collections(page = 1, per_page = 10)
+      params = {
+        page:     page,
+        per_page: per_page
+      }
+
+      list = JSON.parse(connection.get("/users/#{username}/collections", params).body)
       list.map do |collection|
         Unsplash::Collection.new collection.to_hash
       end
@@ -56,4 +89,4 @@ module Unsplash # nodoc:
 
   end
 
-end
+end

data/lib/unsplash/version.rb

@@ -1,4 +1,4 @@
 module Unsplash # :nodoc:
   # :nodoc:
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/lib/unsplash.rb

@@ -12,6 +12,7 @@ require "unsplash/category"
 require "unsplash/curated_batch"
 require "unsplash/collection"
 require "unsplash/stats"
+require "unsplash/search"
 
 module Unsplash
   class << self

data/unsplash.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "unsplash"
   spec.version       = Unsplash::VERSION
   spec.authors       = ["Aaron Klaassen"]
-  spec.email         = ["aaron@crew.co"]
+  spec.email         = ["aaron@unsplash.com"]
 
   spec.summary       = %q{Ruby wrapper for the Unsplash API.}
   spec.homepage      = "https://github.com/unsplash/unsplash_rb"
@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr",     "~> 2.9.3"
   spec.add_development_dependency "webmock", "~> 1.20.4"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls", '~> 0.8.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unsplash
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Aaron Klaassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -108,9 +108,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.12
 description: 
 email:
-- aaron@crew.co
+- aaron@unsplash.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -136,6 +150,7 @@ files:
 - lib/unsplash/curated_batch.rb
 - lib/unsplash/errors.rb
 - lib/unsplash/photo.rb
+- lib/unsplash/search.rb
 - lib/unsplash/stats.rb
 - lib/unsplash/user.rb
 - lib/unsplash/version.rb
@@ -160,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for the Unsplash API.