unsplash 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 595420e78fad1a215cec6dc35751366feb94f7d8
-  data.tar.gz: 782561f5e238a39f3b179f87ab890b195c4047a4
+  metadata.gz: 6e38d0698ca01b7ff19c93da8ee6485081268d23
+  data.tar.gz: 6ee07125feb0c023259edc2fccb028f182ea1f7c
 SHA512:
-  metadata.gz: 36a82849af0ba7c5fe9be5391c11a34bbf60b28a6b799b31d19914c419eecd1bf726c809b0e240c82af1d7d17e2bb3d1b1c63532dee98a7d1e6381d6a96512b7
-  data.tar.gz: 1bc74aa561b0d6050eb7871729bc31bc818056efcb77910e99118a0dc8122ff26e8bb2d19a51dc652c59641a321985c90ff89039499665d8c293ec6252076cf7
+  metadata.gz: 50b9cc311c3268802f4c04e873efeee092aec52419427d300b654dc4e8b8534c4fdc93c7719914e4733e48f4aa8d0d2b28ddb437f1d1a166bfa8a360da88230e
+  data.tar.gz: f2c9cca9709aba66789c67a40ef8eb37f61d315e7c8b857b04844775c987dc9c3bc65bd5e3b55bfb21ff201c9621fdae0215fd7f3cf8a477c8fda8afb0734a42

data/README.md

@@ -33,9 +33,14 @@ Unsplash.configure do |config|
   config.application_id     = "YOUR APPLICATION ID"    
   config.application_secret = "YOUR APPLICATION SECRET"
   config.application_redirect_uri = "https://your-application.com/oauth/callback"
+  config.utm_source = "alices_terrific_client_app"
 end
 ```
 
+#### UTM parameters
+
+As part of [the API guidelines](https://community.unsplash.com/developersblog/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
 
 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!

data/lib/unsplash/configuration.rb

@@ -4,6 +4,7 @@ module Unsplash # :nodoc:
     attr_accessor :application_secret
     attr_accessor :application_redirect_uri
     attr_accessor :logger
+    attr_accessor :utm_source
     attr_writer   :test
 
     def initialize

data/lib/unsplash/connection.rb

@@ -22,8 +22,8 @@ module Unsplash #:nodoc:
       @application_secret = Unsplash.configuration.application_secret
       @api_version        = version
       @api_base_uri       = api_base_uri
-      
-      oauth_base_uri     = oauth_base_uri
+
+      oauth_base_uri = oauth_base_uri
       @oauth = ::OAuth2::Client.new(@application_id, @application_secret, site: oauth_base_uri) do |http|
         http.request :multipart
         http.request :url_encoded
@@ -49,6 +49,24 @@ module Unsplash #:nodoc:
       # TODO check if it succeeded
     end
 
+    # Extract hash with OAuth token attributes.  Extracted token attributes can
+    # be used with create_and_assign_token to prevent the need for
+    # reauthorization.
+    # @return [Hash, nil] @oauth_token converted to a hash.
+    def extract_token
+      @oauth_token.to_hash if @oauth_token
+    end
+
+    # Create and assign new access token from extracted token.  To be used with
+    # extract_token to reauthorize app without api call.
+    # @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
+    end
+
     # Perform a GET request.
     # @param path [String] The path at which to make ther request.
     # @param params [Hash] A hash of request parameters.
@@ -82,6 +100,13 @@ module Unsplash #:nodoc:
     def request(verb, path, params = {})
       raise ArgumentError.new "Invalid http verb #{verb}" if ![:get, :post, :put, :delete].include?(verb)
 
+      params.merge!(utm_params)
+
+      if !Unsplash.configuration.utm_source
+        url = "https://community.unsplash.com/developersblog/unsplash-api-guidelines"
+        Unsplash.configuration.logger.warn "utm_source is required as part of API Terms: #{url}"
+      end
+
       headers = {
         "Accept-Version" => @api_version
         # Anything else? User agent?
@@ -92,7 +117,6 @@ module Unsplash #:nodoc:
 
         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
@@ -116,11 +140,18 @@ module Unsplash #:nodoc:
       { "Authorization" => "Client-ID #{@application_id}" }
     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?
 
       @oauth_token = @oauth_token.refresh_token
     end
   end
-
 end

data/lib/unsplash/version.rb

@@ -1,4 +1,4 @@
 module Unsplash # :nodoc:
   # :nodoc:
-  VERSION = "1.4.3"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unsplash
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Aaron Klaassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-27 00:00:00.000000000 Z
+date: 2017-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty