miniphonic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac264b83a6985c924d3599a733f5d732330c0c9e
+  data.tar.gz: 9fc6b7a8d0c5b49cc1450778b45dd7768f793f9d
+SHA512:
+  metadata.gz: 765613ffe96b56c50e2f52b86d6cc46a75319e0a4f02c129a61c3d3507ba3a03f840a359a9f528f122c4d59a634371b68da8c571a279350710130e763aa09181
+  data.tar.gz: 210d5983832baa8ac0ef21019fbc5fa2978cce0278d571d202cebb752761ac35a78373a4568f3c445a89bd859ce377898b4311559fa3a9379c3387cb017c2498

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset
+.DS_Store
+test.rb
+
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in miniphonic.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    miniphonic (0.1.0)
+      faraday
+      faraday_middleware
+      mime-types
+      multi_json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    metaclass (0.0.1)
+    mime-types (1.25)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.1)
+    multipart-post (1.2.0)
+    rake (10.1.0)
+    vcr (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  miniphonic!
+  mocha
+  rake
+  vcr

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Marcel Langer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,145 @@
+# Miniphonic
+
+Wraps the [auphonic]( https://auphonic.com ) API in delicious Ruby for audio processing bliss.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'miniphonic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install miniphonic
+
+## Usage
+
+First, set up Miniphonic:
+
+```
+require 'miniphonic'
+
+Miniphonic.configure do |m|
+  m.user = "your username"
+  m.password = "much secret wow"
+end
+```
+
+### API objects in general
+
+Both, *productions* and *presets*, are API objects and share most methods. They are simple Ruby objects:
+
+#### Creating
+
+
+```
+production = Miniphonic::Production.new
+preset = Miniphonic::Preset.new
+```
+
+On the server side, those objects are identified by their ```uuid```. 
+
+You usually get one by creating your API object on the server side:
+```
+production.create
+# => production.uuid = "SjRqGhxKhK448Gs6AgAzcZ"
+```
+
+If you already have one, you can create a new API object with a uuid:
+
+```
+production = Miniphonic::Production.new("SjRqGhxKhK448Gs6AgAzcZ")
+```
+
+#### Deleting
+
+Run ```production.delete``` or ```preset.delete``` to delete on the server.
+
+#### Setting/Getting Attributes
+
+Usually, you actually want to do something useful, so you need to add some attributes to your API objects. 
+Miniphonic exposes the "top level" of attributes in dot notation, the rest is handled by the appropriate data structures (hashes and arrays). Take a look at [this page]( https://auphonic.com/api-docs/details.html#one-request ) or ```{preset|production}_attributes.rb``` to see what you can do. 
+
+Quick example:
+```
+production.metadata[:title] = "Hello there, internet"
+production.output_files << {format: "mp3"}
+```
+
+If you set attributes before running ```create```, they will be sent with the creation request, otherwise, use ```object.update``` to set the attributes on the server side.
+
+You can get attributes from the server (thus overwriting the one in your local API object!) by running ```get_attributes```, provided your object already has a ```uuid```.
+
+If you run ```Miniphonic::Production.all``` or ```Miniphonic::Preset.all```, you get an array of all API objects on ther server, already initialized with their uuids. If you need their attributes as well, you need to run ```get_attributes``` on each of them.
+
+#### Pretty pictures
+
+To upload a cover image to a production or preset, use
+```
+production.upload_cover("/path/to/image.jpg")
+preset.upload_cover("yet/another/image.png")
+```
+and smile.
+
+### Productions
+
+#### Getting audio in
+
+You can upload an input file (to a production with a uuid) by running
+
+```
+production.upload_audio("path/to/file")
+```
+
+Or use one from an external service:
+```
+production.upload_audio_from_service("file.m4a","service_uuid")
+```
+
+#### Getting audio out
+
+Add outfiles:
+```
+production.output_files << {format: "mp3", basename: "my_file"}
+```
+
+#### Processing
+
+Start and stop productions (if you have provided an input file and at least one output file):
+
+```
+production.start
+production.stop
+```
+
+### Presets
+
+Presets have a lot less fancy methods than productions, but they work pretty much the same. 
+One caveat: You can't create presets without setting ```preset.name``` first.
+
+### Getting info
+
+The auphonic API is pretty cool about returning information about itself. For example, you can get all your user data with ```Miniphonic.user_data``` or all available algorithms with ```Miniphonic.algorithms```. More info [here]( https://auphonic.com/api-docs/query.html ) or in ```info.rb```. (Heh.)
+
+***
+
+The auphonic API is not really complicated, but there's a lot you can do. Right now, Miniphonic should allow you to do most of the things the API does (as far as I know), but please let me know if something is missing. I'm @sirmarcel on Twitter, that's probably easiest way to get in touch.
+
+Refer to the [API docs]( https://auphonic.com/api-docs/details.html ), the specs and the appropriate classes for further information. 
+
+Do some good now.
+
+<3
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.name = 'spec'
+  test.pattern = 'test/spec/**/*_spec.rb'
+  test.verbose = true
+end
+
+
+Rake::TestTask.new do |t|
+  t.name = 'test'
+  t.pattern = 'test/integration/test_*.rb'
+  t.verbose = true
+end
+
+task :wipe do
+  system "rm -r test/spec/cassettes/"
+end

data/lib/miniphonic/api_object.rb

@@ -0,0 +1,96 @@
+module Miniphonic
+  class ApiObject
+    include Miniphonic::Helpers
+    extend Miniphonic::Helpers
+
+    class << self
+      
+      def all
+        from_server self.new.collection_url do |response|    
+          return response.data.each_with_object([]) do |hash, objects|
+            objects << self.new(hash["uuid"])
+          end
+        end
+      end
+
+    end
+
+    attr_accessor :uuid
+    attr_accessor :data
+
+    def endpoint
+      raise NotImplementedError, "#endpoint has to be overridden in #{ self.class.name }"
+    end
+
+    def attributes_to_payload
+      raise NotImplementedError, "#create has to be overridden in #{ self.class.name }"
+    end
+
+    def payload_to_attributes(payload)
+      raise NotImplementedError, "#attributes_to_payload has to be overridden in #{ self.class.name }"
+    end
+
+    def initialize(uuid = nil)
+      @uuid = uuid
+    end
+
+    # Create an API object on server, will conveniently send already set attributes
+    def create
+      to_server(collection_url, attributes_to_payload) do |response|
+        self.uuid = response.data["uuid"]
+      end
+    end
+
+    # Reset the API object on server and replaces with current attributes
+    # (We can do this brute-force thing because we have local state.)
+    def update
+      url = single_url
+      payload = attributes_to_payload
+      payload[:reset_data] = true
+      to_server url, payload
+    end
+
+    # Update the local API object with the data from the server
+    # (Mostly to be used after ApiObject.new(uuid))
+    def get_attributes
+      from_server single_url do |response|
+        payload_to_attributes(response.data)
+      end
+    end
+
+    def upload_cover(path)
+      command :upload, path_to_payload(path, :image)
+    end
+
+    # Delete API object from server    
+    def delete
+      delete_from_server single_url
+    end
+
+    def command(command, payload = nil)
+      url = command_url(command)
+      to_server url, payload
+    end
+
+    def collection_endpoint
+      endpoint + "s"
+    end
+
+    # URLs
+
+    def collection_url
+      "/api/#{ collection_endpoint }.json"
+    end
+
+    def single_url
+      raise UuidError unless self.uuid
+      "/api/#{ endpoint }/#{ self.uuid }.json"
+    end
+
+    def command_url(command)
+      raise UuidError unless self.uuid
+      "/api/#{ endpoint }/#{ self.uuid }/#{ command }.json"
+    end
+
+  end # class
+end # module

data/lib/miniphonic/helpers.rb

@@ -0,0 +1,51 @@
+require 'mime/types'
+
+module Miniphonic::Helpers
+
+  # Posts data to the server and executes a given block on success
+  def to_server(url, payload = {}, &block)
+    connection = Miniphonic.connect
+    response = connection.post url, payload
+    handle_response(response, &block)
+  end
+
+  # Gets data from the server and executes a given block on success
+  def from_server(url, payload = {}, &block)
+    connection = Miniphonic.connect
+    response = connection.get url, payload
+    handle_response(response, &block)
+  end
+
+  # Deletes data from the server and executes a given block on success
+  def delete_from_server(url, payload = {}, &block)
+    connection = Miniphonic.connect
+    response = connection.delete url, payload
+    if response.success?
+      block.call(response) if block
+      response
+    else
+      server_error(response)
+    end
+  end
+
+  def handle_response(response, &block)
+    if response.success?
+      block.call(response) if block
+      response
+    else
+      server_error(response)
+    end
+  end
+
+  def path_to_payload(path, type)
+    path = File.expand_path(path)
+    filetype = MIME::Types.type_for(path)
+    payload = {}
+    payload[type] = Faraday::UploadIO.new(path, filetype)
+    payload
+  end
+
+  def server_error(response)
+    raise Miniphonic::ServerSideError, "Error on server, responded #{ response.status } with message #{ response.body["error_message"]}."
+  end
+end

data/lib/miniphonic/info.rb

@@ -0,0 +1,68 @@
+module Miniphonic
+  module Info
+    # Methods to retrieve general information from auphonic
+
+    include Miniphonic::Helpers
+
+    # Returns an array of hashes like this:
+    #  {
+    #     "outgoing": true,
+    #     "display_name": "Mr. Derpson",
+    #     "uuid": "h8DesucEK6mepmyxtW83MY",
+    #     "incoming": true,
+    #     "type": "dropbox",
+    #     "email": "me@derp.com"
+    # }
+    def services
+      response = from_server "/api/services.json"
+      response.data
+    end
+
+    # Returns a hash where the keys are outgoing services
+    def service_types
+      get_info :service_types
+    end
+
+    # Returns a hash where the keys are audio processing
+    # algorithms and the values option/info hashes
+    def algorithms
+      get_info :algorithms
+    end
+
+    # Returns a hash of all available output formats (keys)
+    # and their metadata (values)
+    def output_files
+      get_info :output_files
+    end
+
+    # Returns a dictionary of production status codes
+    def status_codes
+      get_info :production_status
+    end
+
+    # Returns a hash of user information
+    def user_info
+      response = from_server "api/user.json"
+      response.data
+    end
+
+    # Returns a hash with the combined data of
+    # output_files, service_types, status_codes, algorithms
+    # as well as all known file endings (those are all keys)
+    def info
+      response = from_server "api/info.json"
+      response.data
+    end
+
+    def files_on(uuid)
+      response = from_server "api/service/#{ uuid }/ls.json"
+      response.data
+    end
+
+    def get_info(name)
+      response = from_server "/api/info/#{ name }.json"
+      response.data
+    end
+
+  end
+end

data/lib/miniphonic/preset.rb

@@ -0,0 +1,17 @@
+require_relative 'preset_attributes'
+
+module Miniphonic
+  class Preset < ApiObject
+    include Attributes::Preset
+
+    def endpoint
+      "preset"
+    end
+
+    def create
+      raise PresetNameError, "You can't create a preset without setting preset.name first." unless name
+      super
+    end
+
+  end
+end

data/lib/miniphonic/preset_attributes.rb

@@ -0,0 +1,53 @@
+module Miniphonic
+  module Attributes
+    module Preset
+      # Slightly tedious, but very non-magic way of defining the API
+
+      attr_accessor :name
+
+      def metadata
+        @metadata ||= {}
+      end
+
+      attr_accessor :output_basename
+
+      def output_files
+        @output_files ||= []
+      end
+
+      def outgoing_services
+        @outgoing_services ||= []
+      end
+
+      def algorithms
+        @algorithms ||= {}
+      end
+
+      def multi_input_files
+        @multi_input_files ||= []
+      end
+
+      def attributes_to_payload
+        payload = {}
+        payload[:preset_name] = name if name
+        payload[:metadata] = metadata unless metadata.empty?
+        payload[:output_basename] = output_basename if output_basename
+        payload[:output_files] = output_files unless output_files.empty?
+        payload[:outgoing_services] = outgoing_services unless outgoing_services.empty?
+        payload[:algorithms] = algorithms unless algorithms.empty?
+        payload[:multi_input_files] = multi_input_files unless multi_input_files.empty?
+        payload
+      end
+
+      def payload_to_attributes(payload)
+        @metadata = payload["metadata"]
+        @name = payload["preset_name"]
+        @output_basename = payload["output_basename"]
+        @output_files = payload["output_files"]
+        @outgoing_services = payload["outgoing_services"]
+        @algorithms = payload["algorithms"]
+        @multi_input_files = payload["multi_input_files"]
+      end
+    end
+  end
+end

data/lib/miniphonic/production.rb

@@ -0,0 +1,33 @@
+require_relative 'production_attributes'
+
+module Miniphonic
+  class Production < ApiObject
+    include Attributes::Production
+
+    def endpoint
+      "production"
+    end
+
+    def upload_audio(path)
+      command :upload, path_to_payload(path, :input_file)
+    end
+
+    # If your file is on a service registered with Auphonic,
+    # use this to not have to upload by hand.
+
+    def upload_audio_from_service(filename, service)
+      self.input_file = filename
+      self.upload_service = service
+      update
+    end
+
+    def start
+      command :start
+    end
+
+    def stop
+      command :stop
+    end
+
+  end
+end

data/lib/miniphonic/production_attributes.rb

@@ -0,0 +1,66 @@
+module Miniphonic
+  module Attributes
+    module Production
+      # Slightly tedious, but very non-magic way of defining the API
+
+      def metadata
+        @metadata ||= {}
+      end
+
+      attr_accessor :preset
+
+      attr_accessor :output_basename
+
+      def output_files
+        @output_files ||= []
+      end
+
+      def outgoing_services
+        @outgoing_services ||= []
+      end
+
+      def algorithms
+        @algorithms ||= {}
+      end
+
+      def chapters
+        @chapters ||= {}
+      end
+
+      attr_accessor :input_file
+      attr_accessor :upload_service
+
+      def multi_input_files
+        @multi_input_files ||= []
+      end
+
+      def attributes_to_payload
+        payload = {}
+        payload[:metadata] = metadata unless metadata.empty?
+        payload[:preset] = preset if preset
+        payload[:output_basename] = output_basename if output_basename
+        payload[:output_files] = output_files unless output_files.empty?
+        payload[:outgoing_services] = outgoing_services unless outgoing_services.empty?
+        payload[:algorithms] = algorithms unless algorithms.empty?
+        payload[:chapters] = chapters unless chapters.empty?
+        payload[:input_file] = input_file if input_file
+        payload[:service] = upload_service if upload_service
+        payload[:multi_input_files] = multi_input_files unless multi_input_files.empty?
+        payload
+      end
+
+      def payload_to_attributes(payload)
+        @metadata = payload["metadata"]
+        @preset = payload["preset"]
+        @output_basename = payload["output_basename"]
+        @output_files = payload["output_files"]
+        @outgoing_services = payload["outgoing_services"]
+        @algorithms = payload["algorithms"]
+        @chapters = payload["chapters"]
+        @input_file = payload["input_file"]
+        @upload_service = payload["service"]
+        @multi_input_files = payload["multi_input_files"]
+      end
+    end
+  end
+end

data/lib/miniphonic/response.rb

@@ -0,0 +1,5 @@
+class Faraday::Response
+  def data
+    body["data"] if body
+  end
+end

data/lib/miniphonic/version.rb

@@ -0,0 +1,3 @@
+module Miniphonic
+  VERSION = "0.1.0"
+end

data/lib/miniphonic.rb

@@ -0,0 +1,40 @@
+require "faraday"
+require "faraday_middleware"
+
+require "miniphonic/version"
+require "miniphonic/helpers"
+require "miniphonic/response"
+require "miniphonic/api_object"
+require "miniphonic/production"
+require "miniphonic/preset"
+require "miniphonic/info"
+
+module Miniphonic
+  extend Miniphonic::Info
+
+  class UuidError < StandardError
+  end
+  class ServerSideError < StandardError
+  end
+  class PresetNameError < StandardError
+  end
+
+  class << self
+    attr_accessor :user, :password
+
+    def configure
+      yield self
+    end
+
+    def connect
+      connection = Faraday.new(url: 'https://auphonic.com') do |con|
+        con.request :multipart
+        con.use FaradayMiddleware::ParseJson
+        con.use FaradayMiddleware::EncodeJson
+        con.adapter :net_http
+      end
+      connection.basic_auth user, password
+      connection
+    end
+  end
+end