giddy 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    giddy (0.0.1)
+    giddy (0.0.2)
       httparty (>= 0.11.0)
       json (>= 1.8.0)
 

data/README.md

@@ -8,28 +8,35 @@ gem install giddy
 ```
 
 ## Configuration
-To set up the authorization configuration, use:
+To set up the authorization configuration for the system (different than your per-user credentials), use:
 
 ```ruby
 Giddy.setup do |config|
   config.system_id = "12345"
   config.system_password = "alongpassword"
-  config.username = "user"
-  config.password = "password"
 end
 ```
 
 ## Usage
+First, create a client object with a username and password
+```ruby
+client = Giddy::Client.new("ausername", "apassword")
+```
+
 Searching:
 ```ruby
-images = Giddy::Image.find(:query => "puppy")
+images = client.search(:query => "puppy")
+
 # or, with pagination
-images = Giddy::Image.find(:query => "kitty", :start => 21, :limit => 20)
+images = client.search(:query => "kitty", :start => 21, :limit => 20)
+
+# or, by image id (returns only one):
+image = client.search(:image_id => "110740425")
 ```
 
 Get an images details:
 ```ruby
-image = Giddy::Image(:image_id => "182405488")
+image = client.search(:image_id => "110740425")
 puts image
 puts image.artist
 ```
@@ -38,3 +45,20 @@ Download request:
 ```ruby
 puts image.download_largest
 ```
+
+It's also possible to cache session information so that you don't have to reauthenticate on each client creation.  For instance:
+```ruby
+client = Giddy::Client.new("username", "password")
+# next line happens automatically if a session doesn't exist or if a session goes stale
+# let's force it, just to get some tokens
+client.create_session
+
+# these can be stored somewhere (memcache, etc)
+token = client.token
+secure_token = client.secure_token
+
+# create a new client with old tokens so a new session doesn't have to be initialized
+# if the tokens have gone stale, a new session will be created
+otherclient = Giddy::Client.new("username", "password", token, secure_token)
+puts otherclient.search(:image_id => "110740425")
+```

data/lib/giddy.rb

@@ -2,9 +2,10 @@ require 'json'
 require 'httparty'
 
 require "giddy/version"
+require "giddy/endpoint"
 require "giddy/config"
 require "giddy/mediator"
-require "giddy/session"
+require "giddy/client"
 require "giddy/search"
 require "giddy/download"
 require "giddy/image"
@@ -16,7 +17,6 @@ module Giddy
   end
 
   def self.setup(&block)
-    config.clear_session
     yield config
     config.check!
   end

data/lib/giddy/client.rb

@@ -0,0 +1,40 @@
+module Giddy
+  class Client
+    def initialize(username, password, token=nil, secure_token=nil)
+      @mediator = Mediator.new(username, password, token, secure_token)
+    end
+
+    def search(attrs)
+      if attrs.has_key?(:image_id) and attrs.keys.length == 1
+        return Search.new(@mediator).get_image_details(attrs[:image_id]).first
+      end
+      
+      attrs = {
+        :limit => 25,
+        :start => 1,
+        :query => "",
+        :additional => {}
+      }.merge(attrs)
+
+      converted = {
+        :Query => { :SearchPhrase =>  attrs[:query] },
+        :ResultOptions => { :ItemCount => attrs[:limit], :ItemStartNumber => attrs[:start] }
+      }
+      attrs = attrs[:additional].merge(converted)
+      Search.new(@mediator).search_for_images(attrs)
+    end
+
+    def token
+      @mediator.token
+    end
+
+    def secure_token
+      @mediator.secure_token
+    end
+
+    # not necessary typically, sessions will be autocreated
+    def create_session
+      @mediator.create_session
+    end
+  end
+end

data/lib/giddy/config.rb

@@ -2,30 +2,19 @@ module Giddy
 
   class Config
     def self.required_fields
-      [ :system_id, :system_password, :username, :password ]
+      [ :system_id, :system_password ]
     end
     
     # system specific information
     attr_accessor :system_id, :system_password
     
-    # user specific information
-    attr_accessor :username, :password
-
-    # session information
-    attr_accessor :token, :secure_token
-
     def check!
       self.class.required_fields.each do |required_field|
         unless send(required_field)
-          raise MissingConfigurationError, "#{required_field} must be set"
+          raise "#{required_field} must be set in config"
         end
       end
     end
-
-    def clear_session
-      @token = nil
-      @secure_token = nil
-    end
   end
 
 end

data/lib/giddy/download.rb

@@ -1,27 +1,18 @@
 module Giddy
-  class Download
-    extend Mediator
-
-    def self.path
-      "download"
+  class Download < Endpoint
+    def initialize(mediator)
+      super mediator, "download", true
     end
 
-    def self.search_for_images(attrs)
-      result = gettyup :SearchForImages, attrs, :SearchForImages2
-      result["Images"].map { |attrs|
-        Image.new(attrs)
-      }
-    end
-    
-    def self.get_largest_image_download_authorizations(ids)
+    def get_largest_image_download_authorizations(ids)
       ids = [ids].flatten.map { |id| { :ImageId => id } }
       result = gettyup :GetLargestImageDownloadAuthorizations, { :Images => ids }
       result["Images"].inject({}) { |h,i| h[i["ImageId"]] = Utils.rubified_hash(i); h }
     end
 
-    def self.create_download_request(tokens)
+    def create_download_request(tokens)
       tokens = [tokens].flatten.map { |token| { :DownloadToken => token } }
-      result = gettyup :CreateDownloadRequest, { :DownloadItems => tokens }, "CreateDownload", true
+      result = gettyup :CreateDownloadRequest, { :DownloadItems => tokens }, "CreateDownload"
       result["DownloadUrls"].inject({}) { |h,i| h[i["ImageId"]] = Utils.rubified_hash(i); h }
     end
   end

data/lib/giddy/endpoint.rb

@@ -0,0 +1,13 @@
+module Giddy
+  class Endpoint
+    def initialize(mediator, path, secure)
+      @mediator = mediator
+      @path = path
+      @secure = secure
+    end
+
+    def gettyup(name, data, bodyname=nil, secure=false)
+      @mediator.gettyup @path, name, data, bodyname, @secure
+    end
+  end
+end

data/lib/giddy/image.rb

@@ -1,23 +1,25 @@
 module Giddy
   class Image
-    def initialize(attrs)
-      if attrs.has_key?(:image_id) and attrs.keys.length == 1
-        attrs = Search.get_image_details(attrs[:image_id]).first
-      end      
+    def initialize(attrs, mediator)
       @attrs = Utils.rubified_hash(attrs)
+      @mediator = mediator
     end
 
     def method_missing(method, *args, &block)
       @attrs.fetch(method, nil)
     end
 
+    def downloader
+      @downloader ||= Download.new(@mediator)
+    end
+
     def largest_available
-      result = Download.get_largest_image_download_authorizations(@attrs[:image_id])
+      result = downloader.get_largest_image_download_authorizations(@attrs[:image_id])
       result[@attrs[:image_id]]
     end
 
     def download_request(token)
-      result = Download.create_download_request(token)
+      result = downloader.create_download_request(token)
       result[@attrs[:image_id]]
     end
 
@@ -27,21 +29,6 @@ module Giddy
       download_request authorizations.first[:download_token]
     end
 
-    def self.find(attrs)
-      attrs = {
-        :limit => 25,
-        :start => 1,
-        :query => "",
-        :additional => {}
-      }.merge(attrs)
-      converted = {
-        :Query => { :SearchPhrase =>  attrs[:query] },
-        :ResultOptions => { :ItemCount => attrs[:limit], :ItemStartNumber => attrs[:start] }
-      }
-      attrs = attrs[:additional].merge(converted)
-      Search.search_for_images(attrs)
-    end
-
     def to_s
       as = @attrs.map { |k,v| "#{k}=#{v}" }.join(", ")
       "<Image #{as}>" 

data/lib/giddy/mediator.rb

@@ -1,19 +1,42 @@
 module Giddy
-  module Mediator
+  class Mediator
     ROOTPATH = "https://connect.gettyimages.com/v1"
+    attr_reader :token, :secure_token
     
-    def gettyup(name, data, bodyname=nil, secure=false, check_token=true)
-      token = secure ? Giddy.config.secure_token : Giddy.config.token
-      if token.nil? and check_token
-        Session.create_session
-        token = secure ? Giddy.config.secure_token : Giddy.config.token
+    def initialize(username, password, token=nil, secure_token=nil)
+      @username = username
+      @password = password
+      @token = token
+      @secure_token = secure_token
+    end
+
+    def create_session
+      data = { 
+        :SystemId => Giddy.config.system_id,
+        :SystemPassword => Giddy.config.system_password,
+        :UserName => @username,
+        :UserPassword => @password
+      }
+      result = fetch "session", nil, nil, :CreateSession, data
+      unless result["ResponseHeader"]["Status"] == "success"
+        raise "Error authenticating: #{result["ResponseHeader"]}"
+      end
+      @token = result["CreateSessionResult"]["Token"]
+      @secure_token = result["CreateSessionResult"]["SecureToken"]
+    end
+
+    def gettyup(path, name, data, bodyname, secure)
+      token = secure ? @secure_token : @token
+      if token.nil?
+        create_session
+        token = secure ? @secure_token : @token
       end
 
-      result = fetch(token, bodyname, name, data)
+      result = fetch(path, token, bodyname, name, data)
 
       if reauth_needed?(result)
-        Session.create_session
-        gettyup name, data, bodyname        
+        create_session
+        gettyup path, name, data, bodyname, secure
       elsif result["ResponseHeader"]["Status"] == "success"
         result["#{name}Result"]
       else
@@ -21,7 +44,7 @@ module Giddy
       end
     end
 
-    def fetch(token, bodyname, name, data)
+    def fetch(path, token, bodyname, name, data)
       body = { :RequestHeader => { :Token => token }, "#{bodyname || name}RequestBody" => data }
       headers = { 'Content-Type' => 'application/json' }
       url = "#{ROOTPATH}/#{path}/#{name}"

data/lib/giddy/search.rb

@@ -1,22 +1,22 @@
 module Giddy
-  class Search
-    extend Mediator
-
-    def self.path
-      "search"
+  class Search < Endpoint
+    def initialize(mediator)
+      super mediator, "search", false
     end
 
-    def self.search_for_images(attrs)
+    def search_for_images(attrs)
       result = gettyup :SearchForImages, attrs, :SearchForImages2
       result["Images"].map { |attrs|
-        Image.new(attrs)
+        Image.new(attrs, @mediator)
       }
     end
     
-    def self.get_image_details(ids)
+    def get_image_details(ids)
       attrs = { :ImageIds => [ids].flatten, :Language => 'en-us' }
       result = gettyup :GetImageDetails, attrs
-      result["Images"]
+      result["Images"].map { |attrs|
+        Image.new(attrs, @mediator)
+      }
     end
   end
 end

data/lib/giddy/version.rb

@@ -1,3 +1,3 @@
 module Giddy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -2,7 +2,7 @@
 name: giddy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Brian Muller
@@ -74,12 +74,13 @@ files:
 - Rakefile
 - giddy.gemspec
 - lib/giddy.rb
+- lib/giddy/client.rb
 - lib/giddy/config.rb
 - lib/giddy/download.rb
+- lib/giddy/endpoint.rb
 - lib/giddy/image.rb
 - lib/giddy/mediator.rb
 - lib/giddy/search.rb
-- lib/giddy/session.rb
 - lib/giddy/utils.rb
 - lib/giddy/version.rb
 homepage: https://github.com/opbandit/giddy
@@ -95,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1099659910985099941
+      hash: 2644968470803126356
       segments: 
       - 0
       version: "0"
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1099659910985099941
+      hash: 2644968470803126356
       segments: 
       - 0
       version: "0"

data/lib/giddy/session.rb

@@ -1,22 +0,0 @@
-module Giddy
-  class Session
-    extend Mediator
-
-    def self.path
-      "session"
-    end
-
-    def self.create_session
-      Giddy.config.clear_session
-      data = { 
-        :SystemId => Giddy.config.system_id,
-        :SystemPassword => Giddy.config.system_password,
-        :UserName => Giddy.config.username,
-        :UserPassword => Giddy.config.password
-      }
-      result = gettyup :CreateSession, data, nil, false, false
-      Giddy.config.token = result["Token"]
-      Giddy.config.secure_token = result["SecureToken"]
-    end
-  end
-end