popuparchive 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4df34b72d100f6c9dbe9a447ed3432eca71ca85
+  data.tar.gz: 4f5346cabc147f30659bb20c4d80272b3e396892
+SHA512:
+  metadata.gz: 44d1b5a28bf0fd405d700e56a652ebd18340bf883175c60dc69a76ad980973e14ee7ba60bf6b6eb78f1e6b0fc234e4912df6ed4ec6999ba949586c66d8d39b23
+  data.tar.gz: bf52ef21e64941fadb907d3521a8fecd5063dfff6137babb728043506545607c1e3ffec58a2f98643843be4cd5d3ac94ad57f7cdf8658fe039ebc17b3167386e

data/lib/popuparchive.rb

@@ -0,0 +1,404 @@
+# Pop Up Archive Ruby SDK
+# Copyright 2014 - Pop Up Archive
+# Licensed under Apache 2 license - see LICENSE file
+#
+#
+
+require 'rubygems'
+require 'json'
+require 'faraday_middleware'
+require 'oauth2'
+require 'uri'
+require 'xmlsimple'
+
+module PopUpArchive
+
+  module Error
+    class NotFound < StandardError
+
+    end
+  end
+
+  class FaradayErrHandler < Faraday::Response::Middleware
+    def on_complete(env)
+      # Ignore any non-error response codes
+      return if (status = env[:status]) < 400
+      #puts "got response status #{status}"
+      case status
+      when 404
+        #raise Error::NotFound
+        # 404 errors not fatal
+      else
+        #puts pp(env)
+        super  # let parent class deal with it
+      end
+    end
+  end
+
+  class Client
+
+    attr_accessor :host
+    attr_accessor :debug
+    attr_accessor :agent
+    attr_accessor :user_agent
+    attr_accessor :cookies
+    attr_accessor :api_endpoint
+    attr_accessor :croak_on_404
+
+    def version
+      return "1.0.0"
+    end
+
+    def initialize(args)
+      #puts args.inspect
+      @un                  = args[:username]
+      @pw                  = args[:password]
+      @oauth_id            = args[:id]
+      @oauth_secret        = args[:secret]
+      @oauth_redir_uri     = args[:redir_uri] || 'urn:ietf:wg:oauth:2.0:oob'
+      @host                = args[:host] || 'https://www.popuparchive.com'
+      @debug               = args[:debug]
+      @user_agent          = args[:user_agent] || 'popuparchive-ruby-client/'+version()
+      @api_endpoint        = args[:api_endpoint] || '/api'
+      @croak_on_404        = args[:croak_on_404] || false
+
+      # normalize host
+      @host.gsub!(/\/$/, '')
+
+      # sanity check
+      begin
+        uri = URI.parse(@host)
+      rescue URI::InvalidURIError => err
+        raise "Bad :host value " + err
+      end
+      if (!uri.host || !uri.port)
+        raise "Bad :host value " + @server
+      end
+
+      @agent = get_agent()
+
+    end
+
+    def get_oauth_token(options={})
+      oauth_options = {
+        site:            @host + @api_endpoint,
+        authorize_url:   @host + '/oauth/authorize',
+        token_url:       @host + '/oauth/token',
+        redirect_uri:    @oauth_redir_uri,
+        connection_opts: options.merge( { :ssl => {:verify => false}, } )
+      }
+
+      # TODO
+
+      client = OAuth2::Client.new(@oauth_id, @oauth_secret, oauth_options) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger if @debug
+        faraday.adapter  :excon
+      end
+
+      token = nil
+      if @un && @pw
+        # TODO 3-legged oauth to @authorize_url
+      else
+        token = client.client_credentials.get_token()
+      end
+
+      return token
+    end
+
+    def get_agent()
+      uri = @host + @api_endpoint
+      opts = {
+        :url => uri,
+        :ssl => {:verify => false},
+        :headers => {
+          'User-Agent'   => @user_agent,
+          'Accept'       => 'application/json',
+          'Cookie'       => @cookies
+        }
+      }
+      @token = get_oauth_token
+      #puts "token="
+      #puts pp(@token)
+      conn = Faraday.new(opts) do |faraday|
+        faraday.request :url_encoded
+        [:mashify, :json].each{|mw| faraday.response(mw) }
+        if !@croak_on_404
+          faraday.use PopUpArchive::FaradayErrHandler
+        else 
+          faraday.response(:raise_error)
+        end
+        faraday.request :authorization, 'Bearer', @token.token
+        faraday.response :logger if @debug
+        faraday.adapter  :excon   # IMPORTANT this is last
+      end
+
+      return conn
+    end
+
+    def get(path, params={})
+      resp = @agent.get @api_endpoint + path, params
+      @debug and puts pp(resp)
+      return PopUpArchive::Response.new resp
+    end
+
+    def post(path, body, content_type='application/json')
+      uri = @api_endpoint + path
+      resp = @agent.post do|req|
+        req.url uri
+        req.body = body
+        req.headers['Content-Type'] = content_type
+      end
+      return PopUpArchive::Response.new resp
+    end
+
+    def get_or_create_item(filename)
+
+
+    end
+
+    def get_collection(coll_id)
+      resp = get('/collections/'+coll_id.to_s)
+      return resp.http_resp.body
+    end
+
+    def get_items(coll_id)
+      resp = get('/collections/'+coll_id.to_s+'/items')
+      return resp.http_resp.body.items
+    end
+
+    def get_item(coll_id, item_id)
+      resp = get('/collections/'+coll_id.to_s+'/items/'+item_id.to_s)
+      return resp.http_resp.body
+    end
+
+    def get_my_uploads
+      resp = get('/collections')
+      my_uploads = nil
+      resp.collections.each do|coll|
+        if coll.title == 'My Uploads'
+          my_uploads = coll
+        end
+      end
+      return my_uploads
+    end 
+
+    def create_item(coll, attrs)
+      resp = post("/collections/#{coll.id}/items", JSON.generate(attrs))
+      return resp.http_resp.body
+    end
+   
+    def create_audio_file(item, attrs={})
+      file = attrs.has_key?(:file) ? URI::encode(attrs.delete(:file)) : nil
+      uri  = "/items/#{item.id}/audio_files"
+      uri  += "?file=#{file}" if file
+      body = JSON.generate({:audio_file => attrs})
+      resp = post(uri, body)
+      #puts "audio_file:"
+      #puts pp resp
+      return resp.http_resp.body
+    end 
+
+    def start_upload(item, af_id, fileattrs)
+      
+      # workflow is:
+      # (1) GET upload_to with audio_file.id
+      # (2) using response, GET get_init_signature
+      #  (example: "key"=>"$token/$filename", "mime_type"=>"image/jpeg", "filename"=>"$filename", "filesize"=>"$n", "last_modified"=>"$e", "item_id"=>"$iid", "audio_file_id"=>"$afid"}
+      # (3) using upload_id, GET get_all_signatures
+      #  (example: {"key"=>"$token/$filename", "mime_type"=>"image/jpeg", "num_chunks"=>"1", "upload_id"=>"$upid", "filename"=>"$filename", "filesize"=>"$n", "last_modified"=>"$e", "item_id"=>"$iid", "audio_file_id"=>"$afid"}
+      # (4) foreach chunk, GET chunk_loaded (optional, since only UI needs this, not a SDK)
+      # (5) finally, GET upload_finished (see finish_upload() below)
+
+      # check 'item' for validity
+      if !item.has_key? :token 
+        raise ":token missing on item"
+      end
+      if !item.has_key? :id
+        raise ":id missing on item"
+      end
+
+      # check 'fileattrs' for validity
+      if !fileattrs.has_key? :filename
+        raise ":filename missing on fileattrs"
+      end
+      if !fileattrs.has_key? :lastmod
+        raise ":lastmod missing on fileattrs"
+      end
+      if !fileattrs.has_key? :size
+        raise ":size missing on fileattrs"
+      end
+      if !fileattrs.has_key? :mime_type
+        raise ":mime_type missing on fileattrs"
+      end
+
+      base_uri = "/items/#{item.id}/audio_files/#{af_id}"
+
+      upload_to_uri = "#{base_uri}/upload_to"
+      upload_to_resp = get(upload_to_uri)
+      puts "upload_to_resp:"
+      puts pp upload_to_resp
+
+      sig_key = "#{item[:token]}/#{fileattrs[:filename]}"
+      sig_params = { 
+        :key           => sig_key,
+        :mime_type     => fileattrs[:mime_type],
+        :filename      => fileattrs[:filename],
+        :filesize      => fileattrs[:size],
+        :last_modified => fileattrs[:lastmod],
+        :item_id       => item.id,
+        :audio_file_id => af_id,
+      }
+      init_sig_uri = "#{base_uri}/get_init_signature?" + Faraday::FlatParamsEncoder.encode(sig_params)
+      init_sig_resp = get(init_sig_uri)
+      puts "init_sig_resp:"
+      puts pp init_sig_resp
+
+      # build the authorization key
+      upload_key = upload_to_resp['key']
+      authz_key = "#{upload_to_resp.provider} #{upload_key}:#{init_sig_resp.signature}"
+
+      # special agent for aws
+      aws_url = "https://#{upload_to_resp.bucket}.s3.amazonaws.com/#{sig_key}"
+      aws_opts = { 
+        :headers => {
+          'User-Agent' => @user_agent,
+          'Authorization' => authz_key,
+          'x-amz-date' => init_sig_resp.date,
+        },
+        :ssl => { :verify => false }   
+      }   
+      aws_agent = Faraday.new(aws_opts) do |faraday|
+        [:mashify, :xml, :raise_error].each{|mw| faraday.response(mw) }
+        faraday.response :logger if @debug
+        faraday.adapter  :excon   # IMPORTANT this is last
+      end
+
+      # post to provider to get the upload_id
+      puts "aws_agent.post"
+      aws_resp = aws_agent.post do |req|
+        req.url "#{aws_url}?uploads"
+        req.headers['Content-Type'] = fileattrs[:mime_type]
+        req.headers['Content-Disposition'] = "attachment; filename=" + fileattrs[:filename]
+        req.headers['x-amz-acl']  = 'public-read'  # TODO
+      end
+      puts "aws response:"
+      puts pp aws_resp
+
+      # pull out the AWS uploadId
+      sig_params[:upload_id] = aws_resp.body.InitiateMultipartUploadResult.UploadId
+
+      # how many chunks do we expect?
+      sig_params[:num_chunks] = fileattrs.has_key?(:num_chunks) ? fileattrs[:num_chunks] : 1
+     
+      all_sig_resp = get("#{base_uri}/get_all_signatures?" + Faraday::FlatParamsEncoder.encode(sig_params))
+      puts "all_sig_resp"
+      puts pp all_sig_resp
+
+      return { 
+        :signatures => all_sig_resp.http_resp.body,
+        :params     => sig_params, 
+        :fileattrs  => fileattrs,
+        :upload_to  => upload_to_resp.http_resp.body,
+        :init_sig   => init_sig_resp.http_resp.body,
+        :aws_url    => aws_url,
+        :aws_agent  => aws_agent,
+      } 
+      
+    end
+
+    def finish_upload(upload)
+      puts "finish_upload:"
+      puts pp upload
+
+      # workflow assumes file has been successfully PUT to AWS
+      # (1) GET aws_url?uploadId=$uploadId
+      # parse xml response for ListPartsResult
+      # (2) POST aws_url?uplaodId=$uploadId with body
+      #  <CompleteMultipartUpload>
+      #   <Part><PartNumber>1</PartNumber><ETag>"$etag_from_ListPartsResult"</ETag></Part>
+      #  </CompleteMultipartUpload>
+      # response to POST contains CompleteMultipartUploadResult with final location
+      # (3) GET pua_url/upload_finished/? with params:
+      #  filename => $filename,
+      #  filesize => $n,
+      #  key      => $sig_key,
+      #  last_modified => $e,
+      #  upload_id => $aws_uploadId,
+
+      # sanity check upload object
+      [:signatures, :params, :fileattrs, :upload_to, :init_sig, :aws_url, :aws_agent].each do|p|
+        if !upload.has_key? p
+          raise ":#{p} missing from upload"
+        end
+      end
+
+      aws_upload_id = upload[:params][:upload_id]
+      aws_agent = upload[:aws_agent]
+      parts_resp = aws_agent.get(upload[:aws_url], {:uploadId => aws_upload_id})
+
+      aws_parts = []
+      parts_resp.ListPartsResult.Part.each do|part|
+        aws_parts.push( { PartNumber: part.PartNumber, ETag: part.ETag })
+      end
+      aws_parts_xml = XmlSimple.xml_out({Part: aws_parts}, {rootname: 'CompleteMultipartUpload', noattr: true})
+      puts "aws_parts_xml: #{aws_parts_xml}"
+      aws_finish_resp = aws_agent.post do|req|
+        req.url "#{upload[:aws_url]}?uploadId=#{aws_upload_id}"
+        req.headers['Content-Type'] = upload[:fileattrs][:mime_type]
+        req.headers['Content-Disposition'] = "attachment; filename=" + upload[:fileattrs][:filename]
+        req.body = aws_parts_xml
+      end
+
+      puts "aws_finish_resp:"
+      puts pp aws_finish_resp
+      
+    end
+
+  end # end Client
+
+  # dependent classes
+  class Response
+
+    attr_accessor :http_resp
+
+    def initialize(http_resp)
+      @http_resp = http_resp
+
+      #warn http_resp.headers.inspect
+      #warn "code=" + http_resp.status.to_s
+
+      @is_ok = false
+      if http_resp.status.to_s =~ /^2\d\d/
+        @is_ok = true
+      end
+
+    end
+
+    def status()
+      return @http_resp.status
+    end
+
+    def is_success()
+      return @is_ok
+    end
+
+    def method_missing(meth, *args, &block)
+      if @http_resp.body.respond_to? meth
+        @http_resp.body.send(meth, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to?(meth)
+      if @http_resp.body.respond_to? meth
+        true
+      else
+        super
+      end
+    end
+
+  end # end Response
+
+end # end module

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: popuparchive
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Peter Karman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby client for the Pop Up Archive API. See https://www.popuparchive.com/
+email: peter@popuparchive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/popuparchive.rb
+homepage: https://github.com/popuparchive/pua-sdk-ruby
+licenses:
+- Apache
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nowarning
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Pop Up Archive API
+test_files: []