playapi 0.0.3 → 0.1.5

data/lib/playapi.rb

@@ -1,6 +1,5 @@
 require 'faraday'
 require 'faraday_middleware'
-require 'hashie'
 require 'playapi/configurable'
 require 'playapi/client'
 require 'playapi/entity'
@@ -9,6 +8,20 @@ require 'playapi/feature'
 require 'playapi/campaign'
 require 'playapi/visual'
 require 'playapi/utils'
+require 'playapi/instapic'
+require 'playapi/checkin'
+require 'playapi/custom'
+require 'playapi/tweet'
+require 'playapi/twitter_scraper'
+require 'playapi/instagrabber'
+require 'playapi/foursquare'
+require 'playapi/picking'
+require 'playapi/voting'
+require 'playapi/snapchatter'
+require 'playapi/snap'
+require 'playapi/account'
+require 'playapi/vine'
+require 'playapi/vine_scraper'
 
 
 module Playapi

data/lib/playapi/account.rb

@@ -0,0 +1,34 @@
+require 'playapi/utils'
+require 'playapi/identity'
+
+
+module Playapi
+	class Account < Playapi::Identity
+		extend Playapi::Utils
+		attr_reader :service_name, :service_id
+
+		def push
+			self.attrs = Playapi::Account.update(id, @attrs).attrs
+		end
+
+		class << self
+
+			def list
+				url = "api/v2/accounts"
+				get_objects(:get, "accounts", url)
+			end
+
+			def get(id)
+				url = "api/v2/accounts/#{id}"
+				get_object(:get, "account", url)
+			end
+
+			def update(id, opts)
+				url = "api/v2/accounts/#{id}"
+				get_object(:put, "account", url, {:account => opts})
+			end
+
+		end
+
+	end
+end

data/lib/playapi/base.rb

@@ -0,0 +1,124 @@
+module Playapi
+  class Base
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @param attrs [Array, Set, Symbol]
+    def self.attr_reader(*attrs)
+      mod = Module.new do
+        attrs.each do |attribute|
+          define_method attribute do
+            @attrs[attribute.to_sym]
+          end
+          define_method "#{attribute}?" do
+            !!@attrs[attribute.to_sym]
+          end
+        end
+      end
+      const_set(:Attributes, mod)
+      include mod
+    end
+
+    # return [Playapi::IdentityMap]
+    def self.identity_map
+      return unless Playapi.identity_map
+      @identity_map = Playapi.identity_map.new unless defined?(@identity_map) && @identity_map.class == Playapi.identity_map
+      @identity_map
+    end
+
+    # Retrieves an object from the identity map.
+    #
+    # @param attrs [Hash]
+    # @return [Playapi::Base]
+    # THIS NEEDS TO BE REIMPLEMENTED
+    def self.fetch(attrs)
+      return unless identity_map
+      if object = identity_map.fetch("#{self.class.to_s.downcase}:#{attrs[:id]}")
+        return object
+      end
+      return yield if block_given?
+    end
+
+    # Stores an object in the identity map.
+    #
+    # @param object [Object]
+    # @return [Playapi::Base]
+    def self.store(object)
+      return object unless identity_map
+      # should this operate on type even though not ever response returns type? (campaign/entities)
+      identity_map.store("#{self.class.to_s.downcase}:#{object.id}", object)
+    end
+
+    # Returns a new object based on the response hash
+    #
+    # @param response [Hash]
+    # @return [Playapi::Base]
+    def self.from_response(response={})
+      fetch_or_new(response[:body])
+    end
+
+    # Retrieves an object from the identity map, or stores it in the
+    # identity map if it doesn't already exist.
+    #
+    # @param attrs [Hash]
+    # @return [Playapi::Base]
+    def self.fetch_or_new(attrs={})
+      return unless attrs
+      return new(attrs) unless identity_map
+
+      fetch(attrs) do
+        object = new(attrs)
+        store(object)
+      end
+    end
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @return [Playapi::Base]
+    def initialize(attrs={})
+      @attrs = attrs
+    end
+
+    # Fetches an attribute of an object using hash notation
+    #
+    # @param method [String, Symbol] Message to send to the object
+    def [](method)
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+    # Retrieve the attributes of an object
+    #
+    # @return [Hash]
+    def attrs
+      @attrs
+    end
+    alias to_hash attrs
+
+    # Update the attributes of an object
+    #
+    # @param attrs [Hash]
+    # @return [Playapi::Base]
+    def update(attrs)
+      @attrs.update(attrs)
+      self
+    end
+
+  protected
+
+    # @param attr [Symbol]
+    # @param other [Playapi::Base]
+    # @return [Boolean]
+    def attr_equal(attr, other)
+      self.class == other.class && !other.send(attr).nil? && send(attr) == other.send(attr)
+    end
+
+    # @param other [Playapi::Base]
+    # @return [Boolean]
+    def attrs_equal(other)
+      self.class == other.class && !other.attrs.empty? && attrs == other.attrs
+    end
+
+  end
+end

data/lib/playapi/campaign.rb

@@ -1,7 +1,9 @@
 require 'playapi/utils'
+require 'playapi/identity'
+
 
 module Playapi
-	class Campaign
+	class Campaign < Playapi::Identity
 		extend Playapi::Utils
 
 		# stub this out for now, it will probably do crazy stuff when we integrate campaign controls.
@@ -42,6 +44,10 @@ module Playapi
 				get_object(:get, "results", url, opts)
 			end
 
+			def features
+				Playapi::Feature.list
+			end
+
 			def create(opts)
 				#raise "WE DON'T MAKE CAMPAIGNS YET"
 				#url = "api/v2/campaigns"

data/lib/playapi/checkin.rb

@@ -0,0 +1,6 @@
+module Playapi
+	class Checkin < Playapi::Interaction
+		attr_reader :location, :source
+
+	end
+end

data/lib/playapi/client.rb

@@ -1,8 +1,10 @@
+require 'playapi/configurable'
+require 'simple_oauth'
 require 'faraday'
 
 module Playapi
 	class Client
-		include Playapi::Configurable # i don't think this is needed
+		include Playapi::Configurable
 
 		def initialize(options={})
 			Playapi::Configurable.keys.each do |key|
@@ -10,33 +12,44 @@ module Playapi
 			end
 		end
 
-		def connection
-			params = {}
-			params[:client_id] = @client_id
-			params[:client_secret] = @client_secret
-			params[:token] = @oauth_token
-
+		private
 
-			@connection ||= Faraday::Connection.new(:url => @endpoint, 
-					:ssl => @ssl,
-					:params => params,
-					:headers => default_headers
-				) do |builder|
-				@connection_middleware.each do |mw|
-						builder.use *mw
+			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
+					) do |builder|
+					@connection_middleware.each do |mw|
+							builder.use *mw
+					end
+					builder.adapter Faraday.default_adapter
 				end
-				builder.adapter Faraday.default_adapter
 			end
-		end
 
-		private
+			def request(method, path, params={}, signature_params=params)
+				connection.send(method.to_sym, path, params) do |request|
+        	request.headers["x-authorization"] = auth_header(method.to_sym, path, signature_params).to_s
+        	request.headers.merge!(default_headers)
+      	end.env
+			end
 
 			def default_headers
 				headers = {
 					:accept => "application/json",
-					:user_agent => "PlayAPI Gem 0.0.1"
+					:user_agent => "PlayAPI Gem 0.1.5"
 				}
 			end
 
+			def auth_header(method, path, params)
+				uri = URI(@endpoint + path)
+				SimpleOAuth::Header.new(method, uri, params, credentials)
+			end
+
 	end
 end

data/lib/playapi/configurable.rb

@@ -9,7 +9,6 @@ module Playapi
     DEFAULT_CONNECTION_MIDDLEWARE = [
       Faraday::Request::Multipart,
       Faraday::Request::UrlEncoded,
-      FaradayMiddleware::Mashify,
       FaradayMiddleware::ParseJson
     ]
 
@@ -21,6 +20,7 @@ module Playapi
           :client_secret,
           :oauth_token,
           :endpoint,
+          :token_secret,
           :connection_options,
           :identity_map,
           :connection_middleware,
@@ -45,10 +45,10 @@ module Playapi
     end
 
     def reset!
-      defaultz = {client_id: "foo", client_secret: "foo", oauth_token: "foo", endpoint: "http://198.199.69.11"}
+      defaultz = {client_id: "F1Ox4PEhf1eiNGRge7kscIRgay1mh8cbi2zruIC1OI", client_secret: "xLeR0lXVdEtfjwP04w4FJKZm8KxS97Qg5o8Xbyw3JeE", oauth_token: "KqoCXCoyhrJTyGFtCYmiUcWModkTYBILiMHyKGQCBYg", token_secret: "b63V8SyY9ip8yigE5o6bsf3HFyza1wRfLnl3HyhhPz4", endpoint: "http://api.papi.io/"}
       # we can probably chuck conn_ops
       conn_ops = {
-        :connection_options => {:headers => {:accept => "application/json", :user_agent => "PlayAPI Gem 0.0.1"}, 
+        :connection_options => {:headers => {:accept => "application/json", :user_agent => "PlayAPI Gem 0.1.1"}, 
           :ssl => {:verify => false}}
       }
       #defaultz.merge!(conn_ops)
@@ -67,9 +67,10 @@ module Playapi
     # @return [Hash]
     def credentials
       {
-        :client_id => @client_id,
-        :client_secret => @client_secret,
+        :consumer_key => @client_id,
+        :consumer_secret => @client_secret,
         :token => @oauth_token,
+        :token_secret => @token_secret
       }
     end
 

data/lib/playapi/custom.rb

@@ -0,0 +1,7 @@
+module Playapi
+	class Custom < Playapi::Interaction
+		def foobar
+			puts "foobar"
+		end
+	end
+end

data/lib/playapi/entity.rb

@@ -1,7 +1,8 @@
 require 'playapi/utils'
+require 'playapi/identity'
 
 module Playapi
-	class Entity
+	class Entity < Playapi::Identity
 		extend Playapi::Utils
 
 		class << self

data/lib/playapi/feature.rb

@@ -1,16 +1,30 @@
 require 'playapi/utils'
 require 'playapi/validation/feature'
 require 'playapi/validation/instagrabber'
-require 'playapi/validation/twitterscraper'
+require 'playapi/validation/twitter_scraper'
 require 'playapi/validation/picking'
+require 'playapi/identity'
 
 
 module Playapi
-	class Feature
+	class Feature < Playapi::Identity
 		extend Playapi::Utils
+		attr_reader :id, :campaign_id, :name, :live, :default_points, :attrs
 
-		def initialize
+		def interactions
+			Playapi::Interaction.by_feature(id)
+		end
+
+		def push
+			Playapi::Feature.update(id, @attrs)
+		end
 
+		def destroy
+			Playapi::Feature.destroy(id)
+		end
+
+		def campaign
+			Playapi::Campaign.get(@attrs["campaign_id"])
 		end
 
 		class << self
@@ -18,7 +32,7 @@ module Playapi
 			# TODO: add filters and options
 			def list
 				url = "api/v2/features"
-				get_object(:get, "features", url)
+				get_objects(:get, "features", url)
 			end
 
 			# Fetch a feature by id
@@ -64,6 +78,14 @@ module Playapi
 				url = "api/v2/features/#{id}"
 				get_object(:delete, "feature", url)
 			end
+			# pass in a hash of options to find things, options include: type and name
+			# returns an array
+			# name=String
+			# type=String
+			def find_by_facet(opts)
+				url = "api/v2/features/facet"
+				get_objects(:get, :features, url, opts)
+			end
 
 		end
 

data/lib/playapi/foursquare.rb

@@ -0,0 +1,10 @@
+module Playapi
+	class Foursquare < Playapi::Feature
+		attr_accessor :authenticated_venues, :client_id, :client_secret, :oauth_token, :push_secret
+
+		def near(coords)
+			#This would be a nice function, no? Shall I add an endpoint just for location items?
+		end
+
+	end
+end

data/lib/playapi/identity.rb

@@ -0,0 +1,49 @@
+require 'playapi/base'
+
+module Playapi
+  class Identity < Playapi::Base
+
+    def self.fetch(attrs)
+      return unless identity_map
+
+      id = attrs[:id]
+      if id  && object = identity_map.fetch(id)
+        return object.update(attrs)
+      end
+
+      return yield if block_given?
+      raise "Not Found!"
+    end
+
+    # Stores an object in the identity map.
+    #
+    # @param object [Object]
+    # @return [Twitter::Identity]
+    def self.store(object)
+      return object unless identity_map
+      identity_map.store(object.id, object)
+    end
+
+    # Initializes a new object
+    #
+    # @param attrs [Hash]
+    # @raise [ArgumentError] Error raised when supplied argument is missing an :id key.
+    # @return [Twitter::Identity]
+    def initialize(attrs={})
+      super
+      raise ArgumentError, "argument must have an :id key" unless id
+    end
+
+    # @param other [Twitter::Identity]
+    # @return [Boolean]
+    def ==(other)
+      super || attr_equal(:id, other) || attrs_equal(other)
+    end
+
+    # @return [Integer]
+    def id
+      @attrs[:id]
+    end
+
+  end
+end

data/lib/playapi/instagrabber.rb

@@ -0,0 +1,6 @@
+module Playapi
+	class Instagrabber < Playapi::Feature
+		attr_reader :hashtags, :user_ids, :client_id, :client_secret, :oauth_token
+
+	end
+end

data/lib/playapi/instapic.rb

@@ -0,0 +1,5 @@
+module Playapi
+	class Instapic < Playapi::Interaction
+		
+	end
+end

data/lib/playapi/interaction.rb

@@ -2,13 +2,36 @@ require 'playapi/utils'
 require 'playapi/validation/instapic'
 require 'playapi/validation/tweet'
 require 'playapi/validation/custom'
+require 'playapi/identity'
 
 
 
 module Playapi
-	class Interaction
+	class Interaction < Playapi::Identity
 		extend Playapi::Utils
 
+		attr_reader :id, :text, :campaign_id, :entity_id, :feature_id
+
+		def feature
+			Playapi::Feature.get(@attrs["feature_id"])
+		end
+
+		def entity
+			Playapi::Entity.get(@attrs["entity_id"])
+		end
+
+		def push
+			self.attrs = Playapi::Interaction.update(id, @attrs).attrs
+		end
+
+		def destroy
+			Playapi::Interaction.destroy(id)
+		end
+
+		def campaign
+			Playapi::Campaign.get(@attrs["campaign_id"])
+		end
+
 		class << self
 
 			# Get interactions for a campaign, optional paramaters include
@@ -21,7 +44,7 @@ module Playapi
 			# :type=STRING 		(Valid options are Instapic, Tweet, Checkin)
 			def list
 				url = "api/v2/interactions"
-				get_object(:get, "interactions", url)
+				get_objects(:get, "interactions", url)
 			end
 
 			# Get an interaction with the given id
@@ -52,10 +75,11 @@ module Playapi
 			end
 
 			# pass in a hash of options to find things, currently the only one that is applicable is content_id
+			# returns an array
 			# content_id=String
 			def find_by_facet(opts)
 				url = "api/v2/interactions/facet"
-				get_object(:get, :interactions, url, opts)
+				get_objects(:get, :interactions, url, opts)
 			end
 
 			# Create a classed interaction for authed campaign

data/lib/playapi/picking.rb

@@ -0,0 +1,17 @@
+require 'playapi/utils'
+require 'playapi/feature'
+
+module Playapi
+	class Picking < Playapi::Feature
+		extend Playapi::Utils
+		attr_reader :target_features, :target_class
+
+		# gets a set of interactions from a picking feature on playapi
+		def get_set(set_size=2, opts={})
+			url = "api/v2/picks/#{id}"
+			# public and private don't matter since you can use send... :/
+			self.class.send(:get_objects, :get, "results", url, opts.merge!(set_size: set_size))
+		end
+
+	end
+end

data/lib/playapi/snap.rb

@@ -0,0 +1,5 @@
+module Playapi
+	class Snap < Playapi::Interaction
+
+	end
+end

data/lib/playapi/snapchatter.rb

@@ -0,0 +1,11 @@
+module Playapi
+	class Snapchatter < Playapi::Feature
+		attr_reader :username, :password
+
+		def send_snapchat(names=[], url='', opts={})
+			# awaiting finalization of end point
+			url = "/api/v2/snapchatter/#{id}/send_snapchat"
+			self.class.send(:get_objects, :post, "results", opts.merge!(usernames: names, source: url))
+		end
+	end
+end

data/lib/playapi/tweet.rb

@@ -0,0 +1,5 @@
+module Playapi
+	class Tweet < Playapi::Interaction
+
+	end
+end

data/lib/playapi/twitter_scraper.rb

@@ -0,0 +1,6 @@
+module Playapi
+	class TwitterScraper < Playapi::Feature
+		attr_accessor :hashtags, :user_ids, :consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret
+
+	end
+end

data/lib/playapi/utils.rb

@@ -8,24 +8,41 @@ module Playapi
 
   	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]
+  		def get_objects(method, key, path, options={})
+  			res = Playapi.client.send(:request, method.to_sym, path, options)
+        puts "\n\n#{res.inspect}\n\n"
+  			if res[:status] == 200
+  				res[:body][key].collect{|y| sym_hash = convert_string_hash_to_sym(y); eval "#{sym_hash[:type]}.new(#{sym_hash})"}
   			else
-          errors = res.body["errors"]
-  				raise "Error returned: #{res.status} #{errors}"
+          #errors = res[:body][:errors]
+  				raise "Error returned: #{res[:status]} #{res[:body][:errors]}"
   			end
   		end
 
-  		def get_objects(method, path, options={})
-  			res = Playapi.client.connection.send(method.to_sym, path, options)
+  		def get_object(method, key, path, options={})
+  			res = Playapi.client.send(:request, method.to_sym, path, options)
   			if res.status == 200
-  				res.body
+  				sym_hash = convert_string_hash_to_sym(res.body[key])
+          eval "#{sym_hash[:type]}.new(#{sym_hash})"
   			else
-  				raise "Error returned: #{res.status}"
+          errors = res.body["errors"]
+  				raise "Error returned: #{res.status} #{errors}"
   			end
   		end
 
+      def get_raw
+        res = Playapi.client.send(:request, 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 convert_string_hash_to_sym(string_hash)
+        q = string_hash.inject({}){|q,(k,v)| q[k.to_sym] = v; q}
+      end
+
   end
 end

data/lib/playapi/validation/instapic.rb

@@ -31,4 +31,4 @@ module Playapi
       
     end
   end
-end
+end  

data/lib/playapi/validation/{twitterscraper.rb → twitter_scraper.rb}

@@ -1,6 +1,6 @@
 module Playapi
   module Validation
-    module Twitterscraper
+    module TwitterScraper
 
     	class << self
 

data/lib/playapi/vine.rb

@@ -0,0 +1,5 @@
+module Playapi
+	class Vine < Playapi::Interaction
+
+	end
+end

data/lib/playapi/vine_scraper.rb

@@ -0,0 +1,6 @@
+module Playapi
+	class VineScraper < Playapi::Feature
+		#attr_accessor :hashtags, :user_ids, :consumer_key, :consumer_secret, :oauth_token, :oauth_token_secret
+
+	end
+end

data/lib/playapi/visual.rb

@@ -3,6 +3,7 @@ require 'playapi/utils'
 module Playapi
 	class Visual
 		extend Playapi::Utils
+		attr_reader :media, :description
 
 		class << self
 

data/lib/playapi/voting.rb

@@ -0,0 +1,6 @@
+module Playapi
+	class Voting < Playapi::Feature
+		attr_reader :target_class
+
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playapi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies: []
 description: Interact with PlayAPI
 email: france@playapi.com
@@ -29,10 +29,26 @@ files:
 - lib/playapi/validation/instapic.rb
 - lib/playapi/validation/tweet.rb
 - lib/playapi/validation/instagrabber.rb
-- lib/playapi/validation/twitterscraper.rb
+- lib/playapi/validation/twitter_scraper.rb
 - lib/playapi/validation/picking.rb
 - lib/playapi/validation/feature.rb
 - lib/playapi/validation/custom.rb
+- lib/playapi/base.rb
+- lib/playapi/identity.rb
+- lib/playapi/instapic.rb
+- lib/playapi/checkin.rb
+- lib/playapi/custom.rb
+- lib/playapi/tweet.rb
+- lib/playapi/twitter_scraper.rb
+- lib/playapi/picking.rb
+- lib/playapi/instagrabber.rb
+- lib/playapi/foursquare.rb
+- lib/playapi/voting.rb
+- lib/playapi/snapchatter.rb
+- lib/playapi/snap.rb
+- lib/playapi/account.rb
+- lib/playapi/vine.rb
+- lib/playapi/vine_scraper.rb
 homepage: http://rubygems.org/gems/playapi
 licenses: []
 post_install_message: