twitpic-full 1.0.0

data/lib/twitpic.rb

@@ -0,0 +1,16 @@
+module TwitPic; end
+
+# Helper for Rails < 1.9.x
+def require_local(path)
+  require(File.expand_path(File.join(File.dirname(__FILE__), path)))
+end
+
+# Load the required libraries
+require 'nestful'
+require 'json'
+require 'roauth'
+
+# Load the TwitPic API library
+require_local 'twitpic/config'
+require_local 'twitpic/api'
+require_local 'twitpic/client'

data/lib/twitpic/api.rb

@@ -0,0 +1,115 @@
+Dir.glob(File.dirname(__FILE__) + '/api/*') {|file| require file}
+
+module TwitPic
+  module API
+    API_BASE = 'http://api.twitpic.com/2/'
+    
+    class << self
+
+      public
+      
+      def query(client, call, args)
+        self.validate(call, args)
+        
+        if call[:method] == :get then
+          self.get(call[:endpoint], args)
+        else
+          self.post(client, call[:endpoint], args)
+        end
+      end
+      
+      # Uploads an image to the TwitPic API
+      #
+      # File can be either the path to the image or
+      # a File object
+      def upload(client, file, args)
+        file = File.open(file) if file.instance_of? String
+        
+        args[:media] = file
+        
+        self.post(client, 'upload', args)
+      end
+      
+      def tweet(client, media)
+        raise ArgumentError, "Invalid argument, must be an object returned from a photo upload" unless media.has_key? 'text'
+        
+        tweet = "#{media['text'][0..114]} #{media['url']}"
+        url = 'http://api.twitter.com/1/statuses/update.json';
+        headers = TwitPic::API.build_header(client, tweet)
+
+        opts = {
+          :headers => headers,
+          :params => {
+            'status' => tweet
+          }
+        }
+        
+        data = Nestful.post(url, opts)
+        
+        return media, JSON.parse(data)
+      end
+    
+      protected
+      
+      def get(endpoint, args = {})
+        url = API_BASE + endpoint + ".json"
+        data = Nestful.get(url, :params => args)
+        JSON.parse(data)
+      end
+      
+      def post(client, endpoint, args = {})  
+        url = API_BASE + endpoint + ".json"
+              
+        # Add API key to arguments
+        args['key'] = client.config.api_key
+
+        headers = TwitPic::API.build_header(client)
+        opts = {
+          :headers => headers,
+          :params => args
+        }
+        
+        if endpoint == 'upload' then
+          opts[:format] = :multipart
+        end
+        
+        data = Nestful.post(url, opts)
+        JSON.parse(data)
+      end
+      
+      def build_header(client, tweet=nil)
+        raise RuntimeError, "Missing application or OAuth credentials" unless client.write_enabled
+        
+        info = {
+          :access_key => client.config.oauth_token,
+          :access_secret => client.config.oauth_secret,
+          :consumer_key => client.config.consumer_key,
+          :consumer_secret => client.config.consumer_secret,
+          :signature_method => "HMAC-SHA1"
+        }
+        
+        if tweet then
+          oauth_url = "http://api.twitter.com/1/statuses/update.json"
+          result = ::ROAuth.header(info, oauth_url, {'status' => tweet}, :post)
+          
+          headers = {
+            'Authorization' => result
+          }
+        else
+          oauth_url = "https://api.twitter.com/1/account/verify_credentials.json"
+          result = ::ROAuth.header(info, oauth_url, {}, :get)
+          
+          headers = {
+            'X-Verify-Credentials-Authorization' => result
+          }
+        end
+      end
+      
+      def validate(info, args)
+        info[:required].each do |item|
+          raise ArgumentError, "Missing required argument " + item + " for " + info[:endpoint] unless args.keys.member?(item)
+        end
+      end
+    end
+  end
+end

data/lib/twitpic/api/comments.rb

@@ -0,0 +1,27 @@
+class TwitPic::Client
+  @@COMMENTS_API = {
+    :show => {
+      :endpoint => 'comments/show',
+      :method => :get,
+      :required => [:media_id, :page]
+    },
+    
+    :create => {
+      :endpoint => 'comments/create',
+      :method => :post,
+      :required => [:media_id, :message]
+    },
+    
+    :delete => {
+      :endpoint => 'comments/delete',
+      :method => :post,
+      :required => [:comment_id]
+    }
+  }
+  
+  def comments(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@COMMENTS_API.keys.member?(action)
+    TwitPic::API.query(self, @@COMMENTS_API[action], args)
+  end
+  
+end

data/lib/twitpic/api/events.rb

@@ -0,0 +1,52 @@
+class TwitPic::Client
+  @@EVENTS_API = {
+    :show => {
+      :endpoint => 'events/show',
+      :method => :get,
+      :required => [:user]
+    }
+  }
+  
+  @@EVENT_API = {
+    :show => {
+      :endpoint => 'event/show',
+      :method => :get,
+      :required => [:id]
+    },
+    
+    :create => {
+      :endpoint => 'event/create',
+      :method => :post,
+      :required => [:name]
+    },
+    
+    :delete => {
+      :endpoint => 'event/delete',
+      :method => :post,
+      :required => [:event_id]
+    },
+    
+    :add => {
+      :endpoint => 'event/add',
+      :method => :post,
+      :required => [:media_id, :event_id]
+    },
+    
+    :remove => {
+      :endpoint => 'event/add',
+      :mehtod => :post,
+      :required => [:event_id, :media_id]
+    }
+  }
+  
+  def events(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@EVENTS_API.keys.member?(action)
+    TwitPic::API.query(self, @@EVENTS_API[action], args)
+  end
+  
+  def event(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@EVENT_API.keys.member?(action)
+    TwitPic::API.query(self, @@EVENT_API[action], args)
+  end
+  
+end

data/lib/twitpic/api/faces.rb

@@ -0,0 +1,33 @@
+class TwitPic::Client
+  @@FACES_API = {
+    :show => {
+      :endpoint => 'faces/show',
+      :method => :post,
+      :required => [:user]
+    },
+    
+    :create => {
+      :endpoint => 'faces/create',
+      :method => :post,
+      :required => [:media_id, :top_coord, :left_coord]
+    },
+    
+    :edit => {
+      :endpoint => 'faces/edit',
+      :method => :post,
+      :required => [:tag_id]
+    },
+    
+    :delete => {
+      :endpoint => 'faces/delete',
+      :method => :post,
+      :required => [:tag_id]
+    }
+  }
+  
+  def faces(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@FACES_API.keys.member?(action)
+    TwitPic::API.query(self, @@FACES_API[action], args)
+  end
+  
+end

data/lib/twitpic/api/media.rb

@@ -0,0 +1,17 @@
+### Added by Clipflakes
+
+class TwitPic::Client
+  @@MEDIA_API = {
+    :show => {
+      :endpoint => 'media/show',
+      :method => :get,
+      :required => [:id]
+    }
+  }
+  
+  def media(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@MEDIA_API.keys.member?(action)
+    TwitPic::API.query(self, @@MEDIA_API[action], args)
+  end
+  
+end

data/lib/twitpic/api/places.rb

@@ -0,0 +1,28 @@
+class TwitPic::Client
+  @@PLACE_API = {
+    :show => {
+      :endpoint => 'place/show',
+      :method => :get,
+      :required => [:id]
+    }
+  }
+  
+  @@PLACES_API = {
+    :show => {
+      :endpoint => 'places/show',
+      :method => :get,
+      :required => [:user]
+    }
+  }
+  
+  def place(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@PLACE_API.keys.member?(action)
+    TwitPic::API.query(self, @@PLACE_API[action], args)
+  end
+  
+  def places(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@PLACES_API.keys.member?(action)
+    TwitPic::API.query(self, @@PLACES_API[action], args)
+  end  
+  
+end

data/lib/twitpic/api/tags.rb

@@ -0,0 +1,27 @@
+class TwitPic::Client
+  @@TAGS_API = {
+    :show => {
+      :endpoint => 'tags/show',
+      :method => :get,
+      :required => [:tag]
+    },
+    
+    :create => {
+      :endpoint => 'tags/create',
+      :method => :post,
+      :required => [:media_id, :tags]
+    },
+    
+    :delete => {
+      :endpoint => 'tags/delete',
+      :method => :post,
+      :required => [:media_id, :tag_id]
+    }
+  }
+  
+  def tags(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@TAGS_API.keys.member?(action)
+    TwitPic::API.query(self, @@TAGS_API[action], args)
+  end
+  
+end

data/lib/twitpic/api/upload.rb

@@ -0,0 +1,19 @@
+class TwitPic::Client
+  
+  # Uploads a photo to TwitPic
+  def upload(file, message)
+    message = "" unless message.strip.length > 0
+    
+    TwitPic::API.upload(self, file, {:message => message})
+  end
+  
+  def upload_and_post(file, message)
+    message = "" unless message.strip.length > 0
+    
+    media = TwitPic::API.upload(self, file, {:message => message})
+    if media then
+      TwitPic::API.tweet(self, media)
+    end
+  end
+  
+end

data/lib/twitpic/api/users.rb

@@ -0,0 +1,15 @@
+class TwitPic::Client
+  @@USERS_API = {
+    :show => {
+      :endpoint => 'users/show',
+      :method => :get,
+      :required => [:username]
+    }
+  }
+  
+  def users(action, args)
+    raise ArgumentError, "Invalid API action given" unless @@USERS_API.keys.member?(action)
+    TwitPic::API.query(self, @@USERS_API[action], args)
+  end
+  
+end

data/lib/twitpic/client.rb

@@ -0,0 +1,28 @@
+module TwitPic
+  # The base interaction class. All of the API methods are called via
+  # the client class once a Client object is created.
+  class Client
+  
+    attr_reader :config, :write_enabled
+    
+    def initialize
+      @config = TwitPic::Config.new
+    end
+    
+    # Lets you change configuration options
+    def configure(&block)
+      raise ArgumentError, "Block required in order to configure" unless block_given?
+      
+      yield @config
+    end
+    
+    # Determines whether all of the required information has been entered into the config
+    # so we know if we can make a write-enabled call or not.  Is this too ghetto/unsafe?
+    def write_enabled
+      enabled = true
+      TwitPic::Config.instance_methods.grep(/\w=$/).each do |method|
+        enabled = false unless @config.send(method.to_s.chop).strip.length > 0
+      end
+    end
+  end
+end

data/lib/twitpic/config.rb

@@ -0,0 +1,14 @@
+module TwitPic
+  class Config
+    attr_accessor :api_key, :consumer_key, :consumer_secret, :oauth_token, :oauth_secret
+    
+    # Setup the default configuration data
+    def initialize
+      @api_key = ''
+      @consumer_key = ''
+      @consumer_secret = ''
+      @oauth_token = ''
+      @oauth_secret = ''
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: twitpic-full
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ryan LeFevre
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nestful
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: roauth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Provides full and simple to use access to the TwitPic API, including photo uploads
+email: meltingice8917@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/twitpic/api/comments.rb
+- lib/twitpic/api/events.rb
+- lib/twitpic/api/faces.rb
+- lib/twitpic/api/media.rb
+- lib/twitpic/api/places.rb
+- lib/twitpic/api/tags.rb
+- lib/twitpic/api/upload.rb
+- lib/twitpic/api/users.rb
+- lib/twitpic/api.rb
+- lib/twitpic/client.rb
+- lib/twitpic/config.rb
+- lib/twitpic.rb
+homepage: https://github.com/meltingice/TwitPic-API-for-Ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.3
+signing_key: 
+specification_version: 3
+summary: Provides full access to the TwitPic API, including photo uploads
+test_files: []
+