stupeflix 0.0.1 → 0.0.2

data/README.md

@@ -20,17 +20,24 @@ Or install it yourself as:
 
 Retrieve your API keys from http://developer.stupeflix.com/keychain/ and then replace the placeholder variables below.
 
-s = Stupeflix.new YOUR_ACCESS_KEY, YOUR_SECRET_KEY, 'user/resource'
-id = 'some_unique_identifier'
+```ruby
+# Set a unique identifier e.g. 'user/resource_id'
+id = "user/resource_id#{Time.now.to_i}"
+
+# Configure credentials
+s = Stupeflix::Video.new id, YOUR_ACCESS_KEY, YOUR_SECRET_KEY
 
 # To PUT a video definition
-s.put_definition definition_xml, id
+s.definition = definition_xml
 
 # POST profiles to request videos be generated accordingly
-s.post_profiles profiles_xml, id
+s.profiles = profiles_xml
 
 # GET status of requested videos
-s.status id
+s.status
+```
+
+See the [examples directory](http://github.com/pgeraghty/stupeflix-api/tree/master/examples) for guidance.
 
 Follow [this link](http://stupeflix-api.readthedocs.org/en/latest/resources/04_video_description_langage.html) for more
 information about how to produce a definition. I recommend Nokogiri's XML builder.

data/examples/example.rb

@@ -0,0 +1,23 @@
+# Set a unique identifier e.g. 'user/resource_id'
+id = "user/resource_id#{Time.now.to_i}"
+
+# Configure credentials
+s = Stupeflix::Video.new id, YOUR_ACCESS_KEY, YOUR_SECRET_KEY
+
+# To PUT a video definition
+s.definition = Stupeflix::Definition.new do |xml|
+  images = %w(qiwD B0-X hXBA rEpt 9w95 ILMo mO6A oUay st5s wExP 01Wb IouW zlCm).map { |i| 'http://gdurl.com/' + i }.shuffle[0...8]
+  xml.stack(duration: 4) {
+    xml.add_image images.pop
+    xml.add_text 'Example', align: 'center,center'
+  }
+  images.each_with_index do |i,x|
+    xml.add_slide i, "Slide #{x}", duration: 4
+  end
+end
+
+# POST profiles to request videos be generated accordingly
+s.profiles = '<profiles><profile name="720p"><stupeflixStore></stupeflixStore></profile></profiles>'
+
+# GET status of requested videos
+s.status

data/lib/stupeflix/version.rb

@@ -1,6 +1,3 @@
-class Stupeflix
-  VERSION = '0.0.1'
-  def self.version
-    VERSION
-  end
+module Stupeflix
+  VERSION = '0.0.2'
 end

data/lib/stupeflix.rb

@@ -1,50 +1,123 @@
 require 'stupeflix/version'
 require 'httparty'
+require 'nokogiri'
 
-class Stupeflix
-  include HTTParty
-  base_uri 'services.stupeflix.com'
+module Stupeflix
+  class Video
+    include HTTParty
+    base_uri 'services.stupeflix.com'
 
-  def initialize key, secret, id_prefix
-    @key, @secret, @prefix = key, secret, id_prefix
-    self.class.default_params AccessKey: key
-  end
+    def initialize id, key, secret
+      @id, @key, @secret = id, key, secret
+      self.class.default_params AccessKey: key
+    end
 
-  def req method, body, mime, t, url
-    md5hex, md5base64 = md5(body) rescue [nil, nil] # md5hex can be compared to etag in response for verification
-    [{ Date: t, Signature: sign([method, md5base64, mime, t, url, nil]*"\n") },
-     body ? { 'Content-MD5' => md5base64.to_s, 'Content-Length' => body.length.to_s, 'Content-Type' => mime } : nil]
-  end
+    def req method, body, mime, t, url
+      md5hex, md5base64 = md5(body) rescue [nil, nil] # md5hex can be compared to etag in response for verification
+      [{ Date: t, Signature: sign([method, md5base64, mime, t, url, nil]*"\n") },
+       body ? { 'Content-MD5' => md5base64.to_s, 'Content-Length' => body.length.to_s, 'Content-Type' => mime } : nil]
+    end
 
-  def put_definition d, id=Time.now.to_i
-    params, headers = req('PUT', d, 'text/xml', Time.now.to_i, url = "#{url id}/definition/")
-    self.class.put url, query: params, headers: headers, body: d
-  end
+    def definition= d
+      params, headers = req('PUT', d, 'text/xml', Time.now.to_i, url = "#{self.url}/definition/")
+      self.class.put url, query: params, headers: headers, body: d
+    end
 
-  def post_profiles profiles, id=Time.now.to_i
-    params, headers = req('POST', body = "ProfilesXML=#{CGI::escape profiles}",
-                          'application/x-www-form-urlencoded', Time.now.to_i, url = "#{url id}/")
-    self.class.post url, query: params, headers: headers, body: body
-  end
+    # TODO make this an array or..?
+    def profiles= profiles_xml
+      params, headers = req('POST', body = "ProfilesXML=#{CGI::escape profiles_xml}",
+                            'application/x-www-form-urlencoded', Time.now.to_i, url = "#{self.url}/")
+      self.class.post url, query: params, headers: headers, body: body
+    end
 
-  def status id=Time.now.to_i
-    params, headers = req('GET', nil, nil, Time.now.to_i, url = "#{url id}/status/")
-    r = self.class.get url, query: params #, format: :json
-    r.parsed_response rescue r
-  end
+    def status
+      params, headers = req('GET', nil, nil, Time.now.to_i, url = "#{self.url}/status/")
+      r = self.class.get url, query: params #, format: :json
+      r.parsed_response rescue r
+    end
 
-  def url id
-    "/stupeflix-1.0/#{@prefix}#{id}"
-  end
+    def url
+      "/stupeflix-1.0/#{@id}" # user/resource
+    end
+
+    protected
 
-  protected
+    def sign str
+      OpenSSL::HMAC.hexdigest OpenSSL::Digest::Digest.new('sha1'), @secret, str
+    end
 
-  def sign str
-    OpenSSL::HMAC.hexdigest OpenSSL::Digest::Digest.new('sha1'), @secret, str
+    def md5 body
+      md5 = Digest::MD5.new().update body
+      [md5.hexdigest, Base64.encode64(md5.digest).strip]
+    end
   end
 
-  def md5 body
-    md5 = Digest::MD5.new().update body
-    [md5.hexdigest, Base64.encode64(md5.digest).strip]
+  class Definition < Nokogiri::XML::Builder
+    EFFECTS = %w(kenburns flower rectangles none) # http://wiki.stupeflix.com/doku.php?id=effects
+    FONTS = %w(arial arialbold arialroundedmtbold comicsansms couriernew landspeedrecord saddlebag timesnewroman verdana)
+    DIRECTIONS = %w(left right up down)
+    TRANSITIONS = %w(circle crossfade cube move over radial scan scans spiral strip swirl under waterdrop)
+    TRANSITIONS_WITH_DIR = %w(cube move over scan spiral under)
+
+    def initialize &block
+      super({}, Nokogiri::XML::Document.new) do |x|
+        x.movie(service: 'craftsman-1.0') {
+          x.body {
+            yield x if block_given?
+          }
+        }
+      end.root
+    end
+
+    def add_slide url, caption, options={}
+      options = { duration: 1 }.merge options
+      add_transition
+      stack(duration: options[:duration]) {
+        add_image url
+        add_text_overlay caption unless caption.length > 0 rescue nil
+      }
+    end
+
+    def add_map map
+      overlay(right: '0.0', bottom: '0.0', width:'0.25') {
+        image filename: map
+        animator type: 'slide-in', direction: 'up', duration:'1.0'
+        animator type: 'slide-out', direction: 'down', 'margin-start' => '6.0'
+      }
+    end
+
+    def add_image url, options={}
+      effect({ type: EFFECTS.sample }.merge options) {
+        image filename: url
+      }
+    end
+
+    def add_text caption, options={}
+      return unless caption.length > 0 rescue nil
+      defaults = { type: 'zone', vector: 'true', align: 'left,bottom' }
+      long_caption = caption.length > 30
+      #defaults[:align] = 'center,top'
+      defaults[:fontsize] = 30 unless long_caption # prevent auto-scale from filling screen with huge text
+      text_(defaults.merge options) {
+        text caption
+        filter(type: 'distancemap', distanceWidth: 40.0)
+        filter type: 'distancecolor', distanceWidth: 40.0, color: '#de7316',
+               strokeColor: '#000000', strokeOpacity: 1.0, strokeWidth: 0.02,
+               dropShadowColor: '#00000044', dropShadowOpacity: 1.0, dropShadowBlurWidth: '0.9',
+               dropShadowPosition: '0.01,-0.01', outerGlowColor: '#ffffff44', outerGlowOpacity: 1.0, outerGlowBlurWidth: 0.7
+      }
+    end
+
+    def add_text_overlay caption, options={}
+      overlay {
+        add_text caption, options
+      }
+    end
+
+    def add_transition options={}
+      defaults = { type: TRANSITIONS.sample }
+      defaults[:direction] = DIRECTIONS.sample if TRANSITIONS_WITH_DIR.include? defaults[:type]
+      transition defaults.merge(options)
+    end
   end
 end

data/stupeflix.gemspec

@@ -5,7 +5,7 @@ require 'stupeflix/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'stupeflix'
-  gem.version       = Stupeflix.version
+  gem.version       = Stupeflix::VERSION
   gem.platform      = Gem::Platform::RUBY
   gem.authors       = ['Paul Geraghty']
   gem.email         = ['muse@appsthatcould.be']
@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'httparty', '>= 0'
+  gem.add_dependency 'nokogiri', '>= 0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stupeflix
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Stupeflix API wrapper using HTTParty
 email:
 - muse@appsthatcould.be
@@ -39,6 +55,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/example.rb
 - lib/stupeflix.rb
 - lib/stupeflix/version.rb
 - stupeflix.gemspec