openphoto-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_STORE
+spec/settings.yml

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in openphoto-ruby.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/Readme.markdown

@@ -0,0 +1,36 @@
+Open Photo API / Ruby Library
+=======================
+#### OpenPhoto, a photo service for the masses
+
+----------------------------------------
+
+<a name="install"></a>
+### Installation
+gem install openphoto-ruby
+
+<a name="ruby"></a>
+### How to use the library
+
+To use the library you need to first require 'openphoto-ruby', retrieve your OAuth credentials, then instantiate an instance of the client and start making calls.
+
+	require 'rubygems'
+	require 'openphoto-ruby'
+
+	@client = Openphoto::Client.new(@site, @consumer_key, @consumer_secret, @access_token, @access_token_secret)
+	photo = @client.connect(:post, "/photo/upload.json", {"photo"=>"/tmp/photo.png", "permission"=>"1", "title"=>"test upload"})
+	puts "#{photo.message} #{@site}/photo/#{photo.result["id"]}/view"
+
+----------------------------------------
+
+<a name="credentials"></a>
+#### Getting your credentials
+
+You can get your credentials by clicking on the arrow next to your email address once you're logged into your site and then clicking on settings.
+If you don't have any credentials then you can create one for yourself by going to `/v1/oauth/flow`.
+Once completed go back to the settings page and you should see the credential you just created
+
+----------------------------------------
+<a name="openphoto"></a>
+#### OpenPhoto installation and API documentation
+
+You can find more information at the main <a href="http://theopenphotoproject.org/documentation">OpenPhoto documentation page</a>.

data/examples.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'openphoto-ruby'
+
+#load our credentials
+options = YAML.load_file("spec/settings.yml")
+@consumer_key =  options["oauth"]["consumer_key"]
+@consumer_secret =  options["oauth"]["consumer_secret"]
+@access_token =  options["oauth"]["access_token"]
+@access_token_secret =  options["oauth"]["access_token_secret"]
+@site =  options["oauth"]["site"]
+
+#create a client
+@client = Openphoto::Client.new(@site, @consumer_key, @consumer_secret, @access_token, @access_token_secret)
+
+#connect to GetHelloWorld
+#http://theopenphotoproject.org/documentation/api/GetHelloWorld
+puts @client.connect(:get, "/hello.json").message
+
+#upload a photo
+#http://theopenphotoproject.org/documentation/api/PostPhotoUpload
+puts "uploading spec/logo.png..."
+photo = @client.connect(:post, "/photo/upload.json", {"photo"=>"spec/logo.png", "permission"=>"1", "title"=>"test upload"})
+puts "#{photo.message} #{@site}/photo/#{photo.result["id"]}/view"
+

data/lib/openphoto-ruby/version.rb

@@ -0,0 +1,5 @@
+module Openphoto
+  module Ruby
+    VERSION = "0.0.1"
+  end
+end

data/lib/openphoto-ruby.rb

@@ -0,0 +1,68 @@
+require "openphoto-ruby/version"
+
+module Openphoto
+
+  class Client
+
+    require 'oauth'
+    require 'json'
+    require 'pp'
+    require 'base64'
+
+    attr_accessor :hostname, :consumer_key, :consumer_secret, :access_token, :access_token_secret
+    
+    def initialize(hostname, consumer_key, consumer_secret, access_token, access_token_secret)
+      @hostname = hostname
+      @consumer_key = consumer_key
+      @consumer_secret = consumer_secret
+      @access_token = access_token
+      @access_token_secret = access_token_secret
+    end
+    
+    def connect(method,path,params={})
+      params["photo"] = Base64.encode64(File.read(params["photo"])) if params.keys.index("photo")
+      access_token = prepare_access_token
+      response = access_token.request(method.to_sym, path, params)
+      response.extend Openphoto::Response
+      return response
+    end
+
+    # Exchange your oauth_token and oauth_token_secret for an AccessToken instance.
+    def prepare_access_token
+      consumer = OAuth::Consumer.new(@consumer_key, @consumer_secret,
+        { :site => @hostname,
+          :scheme => :header,
+          :access_token_path=>"/v1/oauth/token/access",
+          :authorize_path => "/v1/oauth/authorize",
+          :request_token_path => "/v1/oauth/token/request"
+        })
+
+      access_token = OAuth::AccessToken.from_hash(consumer, :oauth_token => @access_token, :oauth_token_secret => @access_token_secret) 
+      return access_token
+    end
+    
+  end
+  
+  module Response
+    #adds OpenPhoto related functions to Net::HTTPResponse
+
+    def json
+      JSON.parse(response.body)
+    end
+    
+    def result
+      json["result"]
+    end
+
+    def message
+      json["message"]
+    end
+    
+    def code
+      json["code"]
+    end
+
+  end
+  
+end
+

data/openphoto-ruby.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "openphoto-ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "openphoto-ruby"
+  s.version     = Openphoto::Ruby::VERSION
+  s.authors     = ["Brian Levine"]
+  s.email       = ["beans@beanserver.net"]
+  s.homepage    = ""
+  s.summary     = "A ruby wrapper to the OpenPhoto API"
+  s.description = "A ruby wrapper to the OpenPhoto API"
+
+  s.rubyforge_project = "openphoto-ruby"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_dependency "oauth", "~> 0.4.5"
+  s.add_dependency "json"
+
+end

data/spec/openphoto_spec.rb

@@ -0,0 +1,71 @@
+require 'openphoto-ruby'
+
+describe Openphoto do
+  before(:each) do
+    options = YAML.load_file("spec/settings.yml")
+    @consumer_key =  options["oauth"]["consumer_key"]
+    @consumer_secret =  options["oauth"]["consumer_secret"]
+    @access_token =  options["oauth"]["access_token"]
+    @access_token_secret =  options["oauth"]["access_token_secret"]
+    @site =  options["oauth"]["site"]
+    @client = Openphoto::Client.new(@site, @consumer_key, @consumer_secret, @access_token, @access_token_secret)
+  end
+  
+  it "says hello world" do
+    out=@client.connect(:get, "/hello.json")
+    out.message.should=="Hello, world!"
+    out.code.should==200
+  end
+
+  it "says hello world with oauth" do
+    out=@client.connect(:get, "/hello.json", {"auth"=>"true"})
+    out.message.should=="Hello, world!"
+    out.code.should==200
+
+    @client = Openphoto::Client.new(@site, "bad credential", @consumer_secret, @access_token, @access_token_secret)
+    out=@client.connect(:get, "/hello.json?auth=true")
+    out.code.should==403
+  end
+
+  context "photos context" do
+
+    it "uploads a photo" do
+      
+      out=@client.connect(:post, "/photo/upload.json", {"photo"=>"spec/logo.png", "permission"=>"1", "title"=>"rspec upload"})
+      out.code.should==202
+      out.message.should match("uploaded successfully")
+      $upload_id = out.result["id"]
+    end
+
+    it "views a photo" do
+      out=@client.connect(:get, "/photo/#{$upload_id}/view.json")
+      out.result["title"].should match("rspec upload")
+      out.code.should==200
+    end
+    
+    it "adds an action" do
+      out=@client.connect(:post, "/action/photo/#{$upload_id}/create.json", {"email"=>"test@openphoto.me", "type"=>"comment", "value"=>"hi there"})
+      out.code.should==200
+      out.code.should_not==403
+      puts out.message
+      puts out.result
+      $comment_id = out.result["id"]
+    end
+    
+    it "deletes an action" do
+      out=@client.connect(:post, "/action/photo/#{$comment_id}/delete.json")
+      out.code.should==200
+      out.code.should_not==403
+    end
+
+    it "deletes a photo" do
+      out=@client.connect(:post, "/photo/#{$upload_id}/delete.json")
+      out.code.should==200
+      out.code.should_not==403
+      out.message.should match("Photo deleted successfully")
+    end
+
+  end
+  
+  
+end

data/spec/settings.yml.example

@@ -0,0 +1,9 @@
+#Getting your credentials
+#You can get your credentials by clicking on the arrow next to your email address once you're logged into your site and #then clicking on settings. If you don't have any credentials then you can create one for yourself by going to #/v1/oauth/flow. Once completed go back to the settings page and you should see the credential you just created
+
+oauth:
+    consumer_key: 3e35bbca3c5973efxxxxxxxxxx
+    consumer_secret: 3179xxxxx
+    access_token: 7158277d9aa5xxxxxxxxxxx
+    access_token_secret: d0f9xxxxx
+    site: http://www.openphoto.me

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: openphoto-ruby
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brian Levine
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 5
+        version: 0.4.5
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: A ruby wrapper to the OpenPhoto API
+email: 
+- beans@beanserver.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.markdown
+- examples.rb
+- lib/openphoto-ruby.rb
+- lib/openphoto-ruby/version.rb
+- openphoto-ruby.gemspec
+- spec/logo.png
+- spec/openphoto_spec.rb
+- spec/settings.yml.example
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: openphoto-ruby
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A ruby wrapper to the OpenPhoto API
+test_files: 
+- spec/logo.png
+- spec/openphoto_spec.rb
+- spec/settings.yml.example