unsplash 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a89f4db0c073875c05c83221e2ff912ff8b414c316b55e6166fb33fb552b84da
-  data.tar.gz: cf552d1afd53ff88378bbdacdfc4ec58af9fb006587360c2f02e759408393660
+  metadata.gz: 02a138e4c3f28999bbac53d0c82eed72a938ead58fb95fb4ec86236f6a6aa8a3
+  data.tar.gz: a0dd3304cdb088fd8859dfde19a0bf7722fd6444eec0e4699aeb25ebfda41492
 SHA512:
-  metadata.gz: dea3bf58a7a162fe55b1fb169da19c3efc365ca1f0eff1157589f0e3a63cf28c4240fb83ab2e0734d598c6d76abb2fd045bf6f65a9cd9b4d70391347d8432380
-  data.tar.gz: 602969d85b3584fc6fc0b9422b8e7240665c71cd2cddeaaa566015a6faf13d2909d0070e6dc470ae1f17b22468d0ec3da776c350e60d95470fee81407c91b891
+  metadata.gz: 15db231f6a97b37af4d8448c02206245a9230ff5c1d7aaf52bf2140c010c94fd744cee4eb9ee9db09f65d72810f869053b906ef5e38ecba51d6523c4f268d4c7
+  data.tar.gz: fb1437ae056f0fb62ea7060c66a7abc66b0810904db29c9c886904b0aa4ef6ae6dfea434a9e58bbcac3a9210f2c607a605c1e8a914552967a8ffc8a04cd4386d

data/lib/unsplash/client.rb

@@ -7,6 +7,7 @@ module Unsplash # :nodoc:
     # @param attrs [Hash]
     def initialize(attrs = {})
       @attributes = OpenStruct.new(attrs)
+      add_utm_to_links
     end
 
     # (Re)load full object details from Unsplash.
@@ -39,6 +40,25 @@ module Unsplash # :nodoc:
       self.class.connection
     end
 
+    # @private
+    def add_utm_params(url)
+      uri = URI.parse(url)
+
+      qs = Rack::Utils.parse_nested_query(uri.query)
+      qs.merge!(connection.utm_params)
+
+      uri.query = Rack::Utils.build_query(qs)
+
+      uri.to_s
+    end
+
+    # @private
+    def add_utm_to_links
+      (@attributes["links"] || {}).each do |key, url|
+        @attributes["links"][key] = add_utm_params(url)
+      end
+    end
+
     class << self
       # The connection object being used to communicate with Unsplash.
       # @return [Unsplash::Connection] the connection

data/lib/unsplash/connection.rb

@@ -94,6 +94,14 @@ module Unsplash #:nodoc:
       request :delete, path, params
     end
 
+    def utm_params
+      {
+        "utm_source"   => Unsplash.configuration.utm_source || "api_app",
+        "utm_medium"   => "referral",
+        "utm_campaign" => "api-credit"
+      }
+    end
+
     private
 
     def request(verb, path, params = {})
@@ -102,7 +110,7 @@ module Unsplash #:nodoc:
       params.merge!(utm_params)
 
       if !Unsplash.configuration.utm_source
-        url = "https://community.unsplash.com/developersblog/unsplash-api-guidelines"
+        url = "https://help.unsplash.com/api-guidelines/unsplash-api-guidelines"
         Unsplash.configuration.logger.warn "utm_source is required as part of API Terms: #{url}"
       end
 
@@ -150,14 +158,6 @@ module Unsplash #:nodoc:
       { "Authorization" => "Client-ID #{@application_access_key}" }
     end
 
-    def utm_params
-      {
-        utm_source:   Unsplash.configuration.utm_source || "api_app",
-        utm_medium:   "referral",
-        utm_campaign: "api-credit"
-      }
-    end
-
     def refresh_token!
       return if !@oauth_token.expired?
 

data/lib/unsplash/photo.rb

@@ -3,6 +3,11 @@ module Unsplash # :nodoc:
   # Unsplash Photo operations.
   class Photo < Client
 
+    def initialize(attrs)
+      super
+      add_utm_to_urls
+    end
+
     # Like a photo for the current user.
     # @return [Boolean] True if successful. Will raise on error.
     def like!
@@ -23,6 +28,12 @@ module Unsplash # :nodoc:
       connection.get(links.download_location)["url"]
     end
 
+    def add_utm_to_urls
+      (@attributes["urls"] || {}).each do |key, url|
+        @attributes["urls"][key] = add_utm_params(url)
+      end
+    end
+
     class << self
 
       # Get a photo. Can be cropped or resized using the optional parameters.
@@ -35,7 +46,7 @@ module Unsplash # :nodoc:
       end
 
       # 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.
+      # a combination of optional parameters.
       # @param count [Integer] Number of photos required. Default=1, Max=30
       # @param featured [Boolean] Limit selection to featured photos.
       # @param user [String] Limit selection to given User's ID.
@@ -44,6 +55,8 @@ module Unsplash # :nodoc:
       # @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, collections: nil, featured: nil, user: nil, query: nil, orientation: nil)
+        Unsplash.configuration.logger.warn "You cannot combine 'collections' and 'query' parameters. 'query' will be ignored." if collections && query
+
         params = {
           collections: (collections && collections.join(",")),
           featured: featured,
@@ -100,7 +113,6 @@ module Unsplash # :nodoc:
       def parse_list(json)
         JSON.parse(json).map { |photo| new photo }
       end
-
     end
   end
 end

data/lib/unsplash/user.rb

@@ -88,6 +88,5 @@ module Unsplash # :nodoc:
         Unsplash::Collection.new collection.to_hash
       end
     end
-
   end
 end

data/lib/unsplash/version.rb

@@ -1,4 +1,4 @@
 module Unsplash # :nodoc:
   # :nodoc:
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unsplash
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Aaron Klaassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty