muvandy 1.0.2a1

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in muvandy.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Aldwin
+
+MIT License
+
+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.md

@@ -0,0 +1,67 @@
+# Muvandy
+
+Client for [Muvandy API](http://muvandy.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+		gem 'muvandy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install muvandy
+
+## To Configure
+
+Create a file in your config/initializers folder named muvandy_setup.rb (or whichever name you prefer)
+
+ 		Muvandy.configure do |c|
+			c.api_key = '<place your api key here>'
+		end
+
+## Get Variations
+
+### Controller
+
+Example of using muvandy on a controller. 
+
+		class HomeController < ApplicationController
+			include Muvandy
+			before_filter :set_muvandy_info, :only => [:index]
+			
+			def index
+				@muvandy = Muvandy.new('experiment-id', :visitor_key => request.remote_ip)
+			end
+		end
+
+A 'visitor_key' is required. You can use the visitor's IP address, email or any unique identifier for the user in your app. 
+
+### Views
+
+		<%= content_tag "h1", @muvandy.get_variation("Headline-1", "Greetings!") %>
+		<p>
+			<%= @muvandy.get_variation("main-text-1") %>
+		</p>
+
+An optional second parameter for 'get_variations' method can be provided to serve as a default value.
+
+### Conversions
+
+		class HomeController < ApplicationController
+			include Muvandy
+			
+			...
+			
+			def thank_you
+			
+				...
+				
+				Muvandy::convert('experiment_id', :visitor_key => request.remote_ip)
+			end
+		end
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/muvandy/muvandy.rb

@@ -0,0 +1,126 @@
+module Muvandy
+  class Muvandy
+    
+    include HTTParty
+    format :xml
+    
+    def initialize(experiment_id, options={})
+      throw Exception.new("Please configure first.") if Muvandy.api_key.blank?
+      throw Exception.new("No given Experiment ID") if experiment_id.nil?
+      
+      @visitor_key = options[:visitor_key] if !options[:visitor_key].blank?
+      
+      # For HTTParty
+      self.class.base_uri Muvandy.site
+      self.class.basic_auth Muvandy.api_key, ''
+      
+      @experiment_id = experiment_id
+      
+      gather_extra_params
+      
+      get_all_variable_variations if options[:skip_variations].blank?
+    end
+
+    def get_variation(variable_key, default="")
+      (@variable_variations[variable_key].blank?) ? default : @variable_variations[variable_key].html_safe
+    end
+
+    def convert!(value=50)
+      post(:convert, :value => value)
+    end
+        
+    private
+    
+    def get_all_variable_variations
+      @variable_variations = {}
+      begin
+        xml = get(:variable_variations)      
+        Rails.logger.debug { "DEBUG ------------ #{xml.parsed_response.inspect}" }
+        if xml.parsed_response && !xml.parsed_response["visitor"].blank?
+          # self.id  = xml.parsed_response["visitor"]["id"].to_i if !xml.parsed_response["visitor"].blank? && !xml.parsed_response["visitor"]["id"].blank?
+          xml.parsed_response["visitor"]["variable_variations"]["variable"].each do |v|
+            @variable_variations[v["key"]] =  v["value"]
+          end
+        end
+      rescue
+      end
+    end
+
+    def api_prefix
+      "/api/v#{Versionomy.parse(VERSION).major}"
+    end
+
+    def get(action, add_to_query={})
+      query_string = case action
+      when :variable_variations
+        "/experiments/#{@experiment_id}/visitors/variable_variations.xml"
+      end
+      begin
+        xml = self.class.get("#{api_prefix}#{query_string}#{extra_params_to_query(add_to_query)}")
+        raise Exception.new(xml.parsed_response["error"]["message"]) if xml.response.code != 200
+      rescue Exception => e
+        Rails.logger.debug { "Muvandy Gem Error: #{e.message}" }
+      end
+      xml
+    end
+
+    def post(action, query={} )
+      query_string = case action
+      when :convert
+        "/experiments/#{@experiment_id}/visitors/convert.xml"
+      end
+      begin
+        xml = self.class.post("#{api_prefix}#{query_string}", :query => query.merge!(:visitor_key => @visitor_key)) # #{extra_params_to_query(add_to_query)}
+        raise Exception.new(xml.parsed_response["error"]["message"]) if xml.response.code != 200
+      rescue Exception => e
+        Rails.logger.debug { "Muvandy Gem Error: #{e.message}" }
+      end
+      xml
+    end
+    
+    def valid_params
+      [ :mode, :visitor_key, :value, :referrer, :utm_term, :utm_campaign, :utm_source, :utm_medium ]
+    end
+    
+    def gather_extra_params
+      @extra_params = {}
+      @extra_params[:mode] = Muvandy.mode  unless Muvandy.mode.blank?
+      @extra_params[:utm_term] = Muvandy.utm_term  unless Muvandy.utm_term.blank?
+      @extra_params[:utm_campaign] = Muvandy.utm_campaign  unless Muvandy.utm_campaign.blank?
+      @extra_params[:utm_source] = Muvandy.utm_source  unless Muvandy.utm_source.blank?
+      @extra_params[:utm_medium] = Muvandy.utm_medium  unless Muvandy.utm_medium.blank?
+      @extra_params[:visitor_key] = @visitor_key  unless @visitor_key.blank? #Muvandy.visitor_key.blank?
+      @extra_params[:referrer] = Muvandy.referrer  unless Muvandy.referrer.blank?
+    end
+
+    def extra_params_to_query(add_to_query={})
+      return '' if @extra_params.blank?
+      
+      query = []
+      params = @extra_params.merge(add_to_query)
+      valid_params.each do |key|
+        query << "#{key}=#{params[key]}" unless params[key].blank?
+      end
+      (query.empty?) ? '' : "?#{query.join('&')}"
+    end
+
+    class << self
+      attr_accessor :api_key, 
+                    :site,
+                    :visitor_key,
+                    :referrer,
+                    :mode,
+                    :utm_term,
+                    :utm_campaign,
+                    :utm_source,
+                    :utm_medium
+      
+      def convert(experiment_id, options={})
+        muvandy = Muvandy.new(experiment_id, options.merge(:skip_variations => true))
+        muvandy.convert!
+      end
+      
+    end
+
+  end
+end

data/lib/muvandy/version.rb

@@ -0,0 +1,4 @@
+require "versionomy"
+module Muvandy
+  VERSION = Versionomy.create(:major => 1, :tiny => 2, :release_type => :alpha).to_s
+end

data/lib/muvandy.rb

@@ -0,0 +1,38 @@
+require "httparty"
+require "muvandy/version"
+require "muvandy/muvandy"
+
+module Muvandy
+  
+  def self.included(base)
+    base.send(:include, ClassMethods)
+  end
+
+  module ClassMethods
+    
+    def set_muvandy_info
+      Muvandy.mode = params[:mode]
+      Muvandy.utm_term = params[:utm_term]
+      Muvandy.utm_campaign = params[:utm_campaign]
+      Muvandy.utm_source = params[:utm_source]
+      Muvandy.utm_medium = params[:utm_medium]
+
+      Muvandy.referrer = request.referrer
+    end 
+
+  end
+ 
+  class << self
+    
+    attr_accessor :api_key, :site
+    
+    def configure
+      yield self
+          
+      Muvandy.api_key = api_key
+      Muvandy.site = (site.nil?) ? 'http://muvandy.com' : site
+    end
+
+  end
+  
+end

data/muvandy.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/muvandy/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Aldwin Ibuna"]
+  gem.email         = ["aibuna@gmail.com"]
+  gem.description   = %q{Client for Muvandy API}
+  gem.summary       = %q{Client for Muvandy API}
+  gem.homepage      = "https://github.com/muvandy/muvandy"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "muvandy"
+  gem.require_paths = ["lib"]
+  gem.add_runtime_dependency(%q<httparty>, ["~> 0.8"])
+  gem.add_runtime_dependency(%q<versionomy>, ["~> 0.4.3"])
+  gem.version       = Muvandy::VERSION  
+  
+  gem.platform    = Gem::Platform::RUBY
+  gem.rubyforge_project = 'muvandy'
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: muvandy
+version: !ruby/object:Gem::Version
+  version: 1.0.2a1
+  prerelease: 5
+platform: ruby
+authors:
+- Aldwin Ibuna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70272925842020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70272925842020
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  requirement: &70272925836180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70272925836180
+description: Client for Muvandy API
+email:
+- aibuna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/muvandy.rb
+- lib/muvandy/muvandy.rb
+- lib/muvandy/version.rb
+- muvandy.gemspec
+homepage: https://github.com/muvandy/muvandy
+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: 1.3.1
+requirements: []
+rubyforge_project: muvandy
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Client for Muvandy API
+test_files: []