piston_api 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'signed_request'
+gem 'monster_mash', '>= 0.2.0'
+gem 'json'
+
+group :test do
+  gem 'rspec', '1.3.1'
+  gem 'vcr', '>= 1.3.0'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Balatero
+
+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.rdoc

@@ -0,0 +1,17 @@
+= piston_api
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 David Balatero. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "piston_api"
+    gem.summary = %Q{Provides a Ruby interface to the MediaPiston API.}
+    gem.description = %Q{Provides a Ruby interface to the MediaPiston API.}
+    gem.email = "david@mediapiston.com"
+    gem.homepage = "http://github.com/mediapiston/piston_api"
+    gem.authors = ["David Balatero"]
+    gem.add_dependency "monster_mash", ">= 0.2.0"
+    gem.add_dependency "signed_request"
+    gem.add_dependency 'json'
+    gem.add_development_dependency "rspec", ">= 1.3.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "piston_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/create_batch.rb

@@ -0,0 +1,30 @@
+require '../lib/piston_api'
+
+PistonApi.sandbox = true
+PistonApi.api_key = 'a688c8abd25fd37e50e8512e75aebbe2d869510368a58f66b6f9f00ed8de'
+PistonApi.private_key = '65469e402f88852f338c79f8e8171ebaf2f6d5a28879799ea9a17c8a6b67'
+
+
+result = PistonApi::Client.create_batch(
+  {
+    'batch' => {
+      'name' => "Character Guides for 'The Simpsons'",
+      'minimum_words' => 250,
+      'topic_overview_instructions' => "Write a short blurb of at least 250-words that describes the given character.",
+      'style_tone_instructions' => "Make it fun to read! Focus on the fictional character in the TV show.",
+      'structure_format_instructions' => "Describe the character's role and personality. Talk about the evolution of the character through the various seasons, or any highlights from the given seasons. As well, mention any important scenes, episodes, or other trivia of relevance about the character.",
+      'content_keywords_instructions' => "Include a quote from the character.",
+      'detail_research_instructions' => "For an example of good writing, please see http://goodwriting.com",
+      'articles' => [
+        { :topic => 'Homer Simpson Character Guide', :metadata => "{ show_id: 1, character_id: 5432 }" },
+        { :topic => 'Milhouse Character Guide', :metadata => "{ show_id: 1, character_id: 432165 }" },
+        { :topic => 'Bart Simpson Character Guide', :metadata => "{ show_id: 1, character_id: 939921 }" },
+        { :topic => 'Principal Skinner Character Guide', :metadata => "{ show_id: 1, character_id: 1432 }" }
+      ]
+    }
+  }
+)
+
+puts "Got back result!"
+puts "-----------------"
+puts result.inspect

data/lib/piston_api.rb

@@ -0,0 +1,18 @@
+require 'signed_request'
+require 'monster_mash'
+require 'json'
+
+module PistonApi
+  VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').chomp
+
+  class << self
+    attr_accessor :api_key
+    attr_accessor :private_key
+    attr_accessor :sandbox
+    alias :sandbox? :sandbox
+  end
+  self.sandbox = false
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'piston_api/client'

data/lib/piston_api/client.rb

@@ -0,0 +1,30 @@
+module PistonApi
+  class Client < MonsterMash::Base
+    defaults do
+      user_agent "MediaPiston API Ruby Client"
+    end
+
+    post :create_batch do |json|
+      uri uri_for('/api/v1/batches')
+      params sign_params(
+        '/api/v1/batches',
+        PistonApi.private_key,
+        :order_data => json.to_json,
+        :api_key => PistonApi.api_key
+      )
+
+      handler do |response|
+        JSON.parse(response.body)
+      end
+    end
+
+    def self.uri_for(path)
+      (PistonApi.sandbox ? 'http://sandbox.mediapiston.com' : 'http://mediapiston.com') << path
+    end
+
+    def self.sign_params(path, api_key, params)
+      params[:signature] = SignedRequest.sign(params, api_key, :path => path)
+      params
+    end
+  end
+end

data/piston_api.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{piston_api}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Balatero"]
+  s.date = %q{2010-11-30}
+  s.description = %q{Provides a Ruby interface to the MediaPiston API.}
+  s.email = %q{david@mediapiston.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/create_batch.rb",
+     "lib/piston_api.rb",
+     "lib/piston_api/client.rb",
+     "piston_api.gemspec",
+     "spec/fixtures/vcr_cassettes/create_batch/basic.yml",
+     "spec/fixtures/vcr_cassettes/create_batch/errors.yml",
+     "spec/piston_api/client_spec.rb",
+     "spec/piston_api_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mediapiston/piston_api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides a Ruby interface to the MediaPiston API.}
+  s.test_files = [
+    "spec/piston_api/client_spec.rb",
+     "spec/piston_api_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/create_batch.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<monster_mash>, [">= 0.2.0"])
+      s.add_runtime_dependency(%q<signed_request>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.3.1"])
+    else
+      s.add_dependency(%q<monster_mash>, [">= 0.2.0"])
+      s.add_dependency(%q<signed_request>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.3.1"])
+    end
+  else
+    s.add_dependency(%q<monster_mash>, [">= 0.2.0"])
+    s.add_dependency(%q<signed_request>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.3.1"])
+  end
+end
+

data/spec/fixtures/vcr_cassettes/create_batch/basic.yml

@@ -0,0 +1,48 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: http://sandbox.mediapiston.com:80/api/v1/batches
+    body: 
+    headers: 
+      user-agent: 
+      - MediaPiston API Client v0.0.0
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      etag: 
+      - "\"6b5916d9534bf8744512cada5aa59145\""
+      content-type: 
+      - application/json; charset=utf-8
+      connection: 
+      - keep-alive
+      x-runtime: 
+      - "9"
+      date: 
+      - Tue, 30 Nov 2010 19:59:32 GMT
+      server: 
+      - nginx/0.7.67
+      content-length: 
+      - "44"
+      cache-control: 
+      - private, max-age=0, must-revalidate
+    body: "{\"batch_id\":1234567890,\"articles_created\":3}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: http://localhost:3000/api/v1/batches
+    body: 
+    headers: 
+      user-agent: 
+      - MediaPiston API Ruby Client
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 0
+      message: 
+    headers: {}
+
+    body: ""
+    http_version: 

data/spec/fixtures/vcr_cassettes/create_batch/errors.yml

@@ -0,0 +1,46 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: http://sandbox.mediapiston.com:80/api/v1/batches
+    body: 
+    headers: 
+      user-agent: 
+      - MediaPiston API Ruby Client
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 400
+      message: Bad Request
+    headers: 
+      content-type: 
+      - application/json; charset=utf-8
+      connection: 
+      - keep-alive
+      x-runtime: 
+      - "4"
+      date: 
+      - Tue, 30 Nov 2010 20:02:45 GMT
+      server: 
+      - nginx/0.7.67
+      content-length: 
+      - "128"
+      cache-control: 
+      - no-cache
+    body: "{\"error\":{\"type\":\"InvalidRequest\",\"messages\":[{\"message\":\"Please enter some article titles.\",\"field\":\"order_data.batch.base\"}]}}"
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :post
+    uri: http://localhost:3000/api/v1/batches
+    body: 
+    headers: 
+      user-agent: 
+      - MediaPiston API Ruby Client
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 0
+      message: 
+    headers: {}
+
+    body: ""
+    http_version: 

data/spec/piston_api/client_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+def mock_batch(articles)
+  {
+    'batch' => {
+      'name' => 'Mock Batch',
+      'minimum_words' => 250,
+      'topic_overview_instructions' => 'Basic instructions.',
+      'articles' => articles
+    }
+  }
+end
+
+def mock_article(topic, options = {})
+  article = {
+    'topic' => topic,
+    'metadata' => 'my metadata'
+  }
+
+  if options[:key_phrases]
+    article['key_phrases'] = [
+      { 'text' => 'savings', 'minimum' => 1 },
+      { 'text' => 'keyword', 'maximum' => 5 }
+    ]
+  end
+
+  article
+end
+
+describe PistonApi::Client do
+  describe "#create_batch" do
+    describe "a basic batch" do
+      before(:all) do
+        @articles = []
+        3.times { |i| @articles << mock_article("Article #{i}") }
+        @batch = mock_batch(@articles)
+      end
+
+      use_vcr_cassette 'create_batch/basic', :record => :new_episodes
+
+      it "should post correctly" do
+        result = PistonApi::Client.create_batch(@batch)
+        result['articles_created'].should == 3
+      end
+    end
+
+    describe "a batch with key phrases" do
+      use_vcr_cassette 'create_batch/key_phrases', :record => :new_episodes
+
+      before(:all) do
+        @articles = []
+        3.times { |i| @articles << mock_article("Article #{i}",
+                                                :key_phrases => true) }
+        @batch = mock_batch(@articles)
+      end
+
+      it "should create 3 articles" do
+        pending "deploy of new key phrases feature"
+        result = PistonApi::Client.create_batch(@batch)
+        result['articles_created'].should == 3
+      end
+    end
+
+    describe "a batch with errors" do
+      use_vcr_cassette 'create_batch/errors', :record => :new_episodes
+
+      it "should raise an error with no articles" do
+        batch = mock_batch([])
+        lambda {
+          PistonApi::Client.create_batch(batch)
+        }.should raise_error
+      end
+    end
+  end
+end

data/spec/piston_api_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe PistonApi do
+  describe "VERSION" do
+    it "should not be blank" do
+      PistonApi::VERSION.should_not be_nil
+    end
+  end
+
+  describe "#api_key" do
+    it "should be settable" do
+      PistonApi.api_key = 'fdsafdsa'
+    end
+
+    it "should be gettable" do
+      PistonApi.api_key = 'fdsafdsa'
+      PistonApi.api_key.should == 'fdsafdsa'
+    end
+  end
+
+  describe "#sandbox" do
+    it "should be settable" do
+      PistonApi.sandbox = true
+      PistonApi.sandbox?.should be_true
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'piston_api'
+require 'spec'
+require 'spec/autorun'
+require 'vcr'
+
+PistonApi.sandbox = true
+PistonApi.api_key = 'a688c8abd25fd37e50e8512e75aebbe2d869510368a58f66b6f9f00ed8de'
+PistonApi.private_key = '65469e402f88852f338c79f8e8171ebaf2f6d5a28879799ea9a17c8a6b67'
+
+VCR.config do |c|
+  c.cassette_library_dir = File.dirname(__FILE__) + "/fixtures/vcr_cassettes"
+  c.stub_with :typhoeus
+end
+
+Spec::Runner.configure do |config|
+  config.extend VCR::RSpec::Macros
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: piston_api
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Balatero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-30 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: monster_mash
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: signed_request
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id004
+description: Provides a Ruby interface to the MediaPiston API.
+email: david@mediapiston.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/create_batch.rb
+- lib/piston_api.rb
+- lib/piston_api/client.rb
+- piston_api.gemspec
+- spec/fixtures/vcr_cassettes/create_batch/basic.yml
+- spec/fixtures/vcr_cassettes/create_batch/errors.yml
+- spec/piston_api/client_spec.rb
+- spec/piston_api_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mediapiston/piston_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides a Ruby interface to the MediaPiston API.
+test_files: 
+- spec/piston_api/client_spec.rb
+- spec/piston_api_spec.rb
+- spec/spec_helper.rb
+- examples/create_batch.rb