playapi 0.0.1 → 0.0.3

data/lib/playapi.rb

@@ -1,3 +1,26 @@
-class Playapi
+require 'faraday'
+require 'faraday_middleware'
+require 'hashie'
+require 'playapi/configurable'
+require 'playapi/client'
+require 'playapi/entity'
+require 'playapi/interaction'
+require 'playapi/feature'
+require 'playapi/campaign'
+require 'playapi/visual'
+require 'playapi/utils'
 
-end
+
+module Playapi
+	class << self
+		include Playapi::Configurable
+
+		def client
+      @client = Playapi::Client.new(options) unless defined?(@client) && @client.hash == options.hash
+      @client
+    end
+
+	end
+end
+
+Playapi.reset! # sets default values

data/lib/playapi/campaign.rb

@@ -0,0 +1,60 @@
+require 'playapi/utils'
+
+module Playapi
+	class Campaign
+		extend Playapi::Utils
+
+		# stub this out for now, it will probably do crazy stuff when we integrate campaign controls.
+
+		class << self
+
+			# Get the primary campaign for which you are currently authorized, one will be able to
+			# pass the name of the campaign, if your credentials are good for multiple campaigns...
+			# but not yet.
+			def get(campaign_name = "index")
+				url = "api/v2/campaigns/"
+				#url += "/#{campaign_name}" unless campaign_name == nil
+				get_object(:get, "campaign", url)
+			end
+
+			# Get interactions for a campaign, optional paramaters include
+			# Optional params hash (opts)
+			# :sort=STRING 		(Valid options are: leaders, newest, oldest)
+			# :approved=BOOL	(Show only approved interactions)
+			# :pending=BOOL		(Show only pending (unapproved) interactions)
+			# :limit=INTEGER 	(Limit to a number of entries, defaults to 10)
+			# :page=INTEGER		(Determines the offset for limit, defaults to 1)
+			# :type=STRING 		(Valid options are Instapic, Tweet, Checkin)
+			def get_interactions(campaign_name, opts = {})
+				#* This could just called Playapi::Interaction.list....
+				url = "api/v2/campaigns/#{campaign_name}/interactions"
+				get_object(:get, "interactions", url, opts).interactions
+			end
+
+			# Get interactions with the most points (highest score) for a campaign
+			# Optional params hash (opts)
+			# :limit=INTEGER 	(Limit to a number of entries, defaults to 10)
+			# :page=INTEGER		(Determines the offset for limit, defaults to 1)
+			# :type=STRING 		(Valid options are Instapic, Tweet, Checkin)
+			def leaders(campaign_name, opts = {})
+				#* This could just call Playapi::Interactions.list with most points params...
+				url = "api/v2/campaigns/#{campaign_name}/leaders"
+				get_object(:get, "results", url, opts)
+			end
+
+			def create(opts)
+				#raise "WE DON'T MAKE CAMPAIGNS YET"
+				#url = "api/v2/campaigns"
+				#get_object(:get, "interaction", url, {:entity => opts})
+			end
+
+			def update(name, opts)
+				#raise "WE DON'T UPDATE CAMPAIGNS YET"
+				#url = "api/v2/campaigns/#{id}"
+				#get_object(:put, "campaign", url, {:entity => opts})
+			end
+
+		end
+
+	end
+end

data/lib/playapi/client.rb

@@ -0,0 +1,42 @@
+require 'faraday'
+
+module Playapi
+	class Client
+		include Playapi::Configurable # i don't think this is needed
+
+		def initialize(options={})
+			Playapi::Configurable.keys.each do |key|
+				instance_variable_set(:"@#{key}", options[key] || Playapi.instance_variable_get(:"@#{key}"))
+			end
+		end
+
+		def connection
+			params = {}
+			params[:client_id] = @client_id
+			params[:client_secret] = @client_secret
+			params[:token] = @oauth_token
+
+
+			@connection ||= Faraday::Connection.new(:url => @endpoint, 
+					:ssl => @ssl,
+					:params => params,
+					:headers => default_headers
+				) do |builder|
+				@connection_middleware.each do |mw|
+						builder.use *mw
+				end
+				builder.adapter Faraday.default_adapter
+			end
+		end
+
+		private
+
+			def default_headers
+				headers = {
+					:accept => "application/json",
+					:user_agent => "PlayAPI Gem 0.0.1"
+				}
+			end
+
+	end
+end

data/lib/playapi/configurable.rb

@@ -0,0 +1,94 @@
+module Playapi
+  module Configurable
+    extend Forwardable
+    attr_writer :client_id, :client_secret, :oauth_token
+    attr_accessor :endpoint, :connection_options, :identity_map, :connection_middleware
+    def_delegator :options, :hash
+
+
+    DEFAULT_CONNECTION_MIDDLEWARE = [
+      Faraday::Request::Multipart,
+      Faraday::Request::UrlEncoded,
+      FaradayMiddleware::Mashify,
+      FaradayMiddleware::ParseJson
+    ]
+
+    class << self
+
+      def keys
+        @keys ||= [
+          :client_id,
+          :client_secret,
+          :oauth_token,
+          :endpoint,
+          :connection_options,
+          :identity_map,
+          :connection_middleware,
+        ]
+      end
+
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    #
+    # @raise [Twitter::Error::ConfigurationError] Error is raised when supplied
+    #   twitter credentials are not a String or Symbol.
+    def configure
+      yield self
+      validate_credential_type!
+      self
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    def reset!
+      defaultz = {client_id: "foo", client_secret: "foo", oauth_token: "foo", endpoint: "http://198.199.69.11"}
+      # we can probably chuck conn_ops
+      conn_ops = {
+        :connection_options => {:headers => {:accept => "application/json", :user_agent => "PlayAPI Gem 0.0.1"}, 
+          :ssl => {:verify => false}}
+      }
+      #defaultz.merge!(conn_ops)
+
+      defaultz.merge!(:connection_middleware => DEFAULT_CONNECTION_MIDDLEWARE)
+
+      Playapi::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", defaultz[key])
+      end
+      self
+    end
+    alias setup reset!
+
+  private
+
+    # @return [Hash]
+    def credentials
+      {
+        :client_id => @client_id,
+        :client_secret => @client_secret,
+        :token => @oauth_token,
+      }
+    end
+
+    # @return [Hash]
+    def options
+      Hash[Playapi::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+    # Ensures that all credentials set during configuration are of a
+    # valid type. Valid types are String and Symbol.
+    def validate_credential_type!
+      credentials.each do |credential, value|
+        next if value.nil?
+
+        unless value.is_a?(String) || value.is_a?(Symbol)
+          raise "Invalid #{credential} specified: #{value} must be a string or symbol."
+        end
+      end
+    end
+
+  end
+end

data/lib/playapi/entity.rb

@@ -0,0 +1,27 @@
+require 'playapi/utils'
+
+module Playapi
+	class Entity
+		extend Playapi::Utils
+
+		class << self
+
+			def get(id)
+				url = "api/v2/entities/#{id}"
+				get_object(:get, "entity", url)
+			end
+
+			def create(opts)
+				url = "api/v2/entities"
+				get_object(:get, "entity", url, {:entity => opts})
+			end
+
+			def update(id, opts)
+				url = "api/v2/entities/#{id}"
+				get_object(:put, "entity", url, {:entity => opts})
+			end
+
+		end
+
+	end
+end

data/lib/playapi/feature.rb

@@ -0,0 +1,71 @@
+require 'playapi/utils'
+require 'playapi/validation/feature'
+require 'playapi/validation/instagrabber'
+require 'playapi/validation/twitterscraper'
+require 'playapi/validation/picking'
+
+
+module Playapi
+	class Feature
+		extend Playapi::Utils
+
+		def initialize
+
+		end
+
+		class << self
+			# Get a list of features for auth campaign
+			# TODO: add filters and options
+			def list
+				url = "api/v2/features"
+				get_object(:get, "features", url)
+			end
+
+			# Fetch a feature by id
+			def get(id)
+				url = "api/v2/features/#{id}"
+				get_object(:get, "feature", url)
+			end
+
+			# Create a new feature for authed campaign
+			#
+			# Type is a string that corresponds to a Playapi Feature class
+			#
+			# Valid options are:
+			#  		type=STRING (Valid Options: Picking, Voting, Instagrabber, TwitterScraper, Foursquare)
+			#
+			# Required fields for ALL types (opts)
+			# 		:name=STRING
+			# 		:description=STRING
+			#
+			# Required fields for Instagrabber, TwitterScraper, Foursquare
+			# 		:default_points=FLOAT (Default is 0)
+			#
+			# Required fields for Instagrabber, TwitterScraper
+			# 		:hashtags=Array 		(Array of hashtags to watch)
+
+			def create(type, opts)
+				url = "api/v2/features"
+				#validator = "Playapi::Validation::#{type.split('_').map {|w| w.capitalize}.join}".split("::").inject(Module) {|acc, val| acc.const_get(val)}
+				#validator.validate(opts)
+				get_object(:post, "feature", url, {:feature => opts, :type => type})
+			end
+
+			# Update a feature with the given id
+			# 		See create for field details.
+
+			def update(id, opts)
+				url = "api/v2/features/#{id}"
+				get_object(:put, "feature", url, {:feature => opts})
+			end
+
+			# destroy a feature
+			def destroy(id)
+				url = "api/v2/features/#{id}"
+				get_object(:delete, "feature", url)
+			end
+
+		end
+
+	end
+end

data/lib/playapi/interaction.rb

@@ -0,0 +1,94 @@
+require 'playapi/utils'
+require 'playapi/validation/instapic'
+require 'playapi/validation/tweet'
+require 'playapi/validation/custom'
+
+
+
+module Playapi
+	class Interaction
+		extend Playapi::Utils
+
+		class << self
+
+			# Get interactions for a campaign, optional paramaters include
+			# Optional params hash (opts)
+			# :sort=STRING 		(Valid options are: leaders, newest, oldest)
+			# :approved=BOOL	(Show only approved interactions)
+			# :pending=BOOL		(Show only pending (unapproved) interactions)
+			# :limit=INTEGER 	(Limit to a number of entries, defaults to 10)
+			# :page=INTEGER		(Determines the offset for limit, defaults to 1)
+			# :type=STRING 		(Valid options are Instapic, Tweet, Checkin)
+			def list
+				url = "api/v2/interactions"
+				get_object(:get, "interactions", url)
+			end
+
+			# Get an interaction with the given id
+			def get(id)
+				url = "api/v2/interactions/#{id}"
+				get_object(:get, "interaction", url)
+			end
+
+			# Create a custom interaction for your campaign
+			# Optional fields (opts)
+			# :entity_id=STRING (Playapi Entity ID - ONLY USE THIS IF YOU HAVE A PLAYAPI PROVIDED ENTITY_ID)
+			# :points=Float (Points for this interaction)
+			# WILL BE DEPRECATED IN VERSION 0.0.2, please use classed_interaction! NOT A JOKE
+			def create(opts)
+				url = "api/v2/interactions"
+				get_object(:post, "interaction", url, {:interaction => opts})
+			end
+
+			# Update a specific interaction for your campaign
+			def update(id, opts)
+				url = "api/v2/interactions/#{id}"
+				get_object(:put, "interaction", url, {:interaction => opts})
+			end
+
+			def destroy(id)
+				url = "api/v2/interactions/#{id}"
+				get_object(:delete, "interaction", url)
+			end
+
+			# pass in a hash of options to find things, currently the only one that is applicable is content_id
+			# content_id=String
+			def find_by_facet(opts)
+				url = "api/v2/interactions/facet"
+				get_object(:get, :interactions, url, opts)
+			end
+
+			# Create a classed interaction for authed campaign
+			#
+			# Type is a string corresponds to a Playapi Interaction class
+			#
+			# Valid options are:
+			# 		:type=STRING (Valid Options: Custom, Instapic, Tweet)
+			#  			Instapic(:content_id, :)
+			# 
+			#
+			# ID VALUES FOR THIS CLASS ARE PROVIDED BY PLAYAPI AND MUST MATCH !!!
+			# IF THE ID VALUES DON'T MATCH, YOUR GONNA HAVE A BAD TIME !!!
+			#
+			# Required fields for ALL types (opts)
+			# 	:feature_id=STRING 	(Playapi Feature ID )
+			# 	:points=FLOAT			(Points for this interaction)
+			#   :content_id=STRING 	(3rd party (twitter status_id, etc) id from which content was sourced)
+			#
+			# Required fields for Instapics
+			# 	:asset_url=STRING 	(URL of the instagram image)
+			#
+			# Required fields for Tweet
+			#   :text=STRING 			 	(Text from a Tweet)
+
+			def classed_interaction(type="Custom", opts = {})
+				url = "api/v2/interactions"
+				validator = "Playapi::Validation::#{type.split('_').map {|w| w.capitalize}.join}".split("::").inject(Module) {|acc, val| acc.const_get(val)}
+				validator.validate(opts)
+				get_object(:post, "interaction", url, {:interaction => opts, :type => type})
+			end
+
+		end
+
+	end
+end

data/lib/playapi/utils.rb

@@ -0,0 +1,31 @@
+module Playapi
+  module Utils
+  	class << self
+  		def hi
+  			return true
+  		end
+  	end
+
+  	private
+
+  		def get_object(method, key, path, options={})
+  			res = Playapi.client.connection.send(method.to_sym, path, options)
+  			if res.status == 200
+  				res.body[key]
+  			else
+          errors = res.body["errors"]
+  				raise "Error returned: #{res.status} #{errors}"
+  			end
+  		end
+
+  		def get_objects(method, path, options={})
+  			res = Playapi.client.connection.send(method.to_sym, path, options)
+  			if res.status == 200
+  				res.body
+  			else
+  				raise "Error returned: #{res.status}"
+  			end
+  		end
+
+  end
+end

data/lib/playapi/validation/custom.rb

@@ -0,0 +1,31 @@
+module Playapi
+  module Validation
+    module Custom
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :name
+          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |interaction_field, value|
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{interaction_field} specified: #{value} must be a string or a number") unless value == points
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/validation/feature.rb

@@ -0,0 +1,32 @@
+module Playapi
+  module Validation
+    module Feature
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :name,
+            :description          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |field, value|
+          	raise "Type should not be specified in options!" if field.to_s == "type"
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{value} specified: #{field} must be a string or a number") unless value == points
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/validation/instagrabber.rb

@@ -0,0 +1,36 @@
+module Playapi
+  module Validation
+    module Instagrabber
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :name,
+            :description,
+            :type,
+            :client_id,
+            :client_secret
+          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |field, value|
+          	raise "Type should not be specified in options!" if field.to_s == "type"
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{value} specified: #{field} must be a string or a number") unless value == points
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/validation/instapic.rb

@@ -0,0 +1,34 @@
+module Playapi
+  module Validation
+    module Instapic
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :feature_id,
+            :asset_url,
+            :content_id,
+            :name
+          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |interaction_field, value|
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{interaction_field} specified: #{value} must be a string or a number")
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/validation/picking.rb

@@ -0,0 +1,34 @@
+module Playapi
+  module Validation
+    module Picking
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :name,
+            :description,
+            :feature_targets
+          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |field, value|
+          	raise "Type should not be specified in options!" if field.to_s == "type"
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{value} specified: #{field} must be a string or a number") unless value == points
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/validation/tweet.rb

@@ -0,0 +1,33 @@
+module Playapi
+  module Validation
+    module Tweet
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :feature_id,
+            :content_id,
+            :name
+          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |interaction_field, value|
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{interaction_field} specified: #{value} must be a string or a number")
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/validation/twitterscraper.rb

@@ -0,0 +1,37 @@
+module Playapi
+  module Validation
+    module Twitterscraper
+
+    	class << self
+
+        def pkeys
+          @pkeys ||= [
+            :name,
+            :description,
+            :client_id,
+            :client_secret,
+            :oauth_token,
+            :oauth_token_secret
+          ]
+        end
+
+        def validate(opts)
+          pkeys.each do |p|
+            unless opts.include?(p)
+              raise "#{p} must not be nil"
+            end
+          end
+          opts.each do |field, value|
+          	raise "Type should not be specified in options!" if field.to_s == "type"
+            #next if value.nil?
+
+            unless value.is_a?(String) || value.is_a?(Integer) || value.is_a?(Float)
+              raise("Invalid #{value} specified: #{field} must be a string or a number") unless value == points
+            end
+          end
+        end
+    	end
+      
+    end
+  end
+end

data/lib/playapi/visual.rb

@@ -0,0 +1,37 @@
+require 'playapi/utils'
+
+module Playapi
+	class Visual
+		extend Playapi::Utils
+
+		class << self
+
+			def get_all
+				url "api/v2/visuals"
+				get_object(:get, "visuals", url)
+			end
+
+			def get(id)
+				url = "api/v2/visuals/#{id}"
+				get_object(:get, "visual", url)
+			end
+
+			def create(opts)
+				url = "api/v2/visuals"
+				get_object(:post, "visual", url, {:visual => opts})
+			end
+
+			def update(id, opts)
+				url = "api/v2/visuals/#{id}"
+				get_object(:put, "visual", url, {:visual => opts})
+			end
+
+			def destroy(id)
+				url = "api/v2/visuals/#{id}"
+				get_object(:delete, "visual", url)
+			end
+
+		end
+
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playapi
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Interact with PlayAPI
 email: france@playapi.com
@@ -18,6 +18,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/playapi.rb
+- lib/playapi/client.rb
+- lib/playapi/entity.rb
+- lib/playapi/interaction.rb
+- lib/playapi/visual.rb
+- lib/playapi/feature.rb
+- lib/playapi/campaign.rb
+- lib/playapi/configurable.rb
+- lib/playapi/utils.rb
+- lib/playapi/validation/instapic.rb
+- lib/playapi/validation/tweet.rb
+- lib/playapi/validation/instagrabber.rb
+- lib/playapi/validation/twitterscraper.rb
+- lib/playapi/validation/picking.rb
+- lib/playapi/validation/feature.rb
+- lib/playapi/validation/custom.rb
 homepage: http://rubygems.org/gems/playapi
 licenses: []
 post_install_message: