linkshare 0.0.9

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,18 @@
+linkshare
+
+LinkShare HTTP web service interface
+
+Currently you will need a ~/.linkshare.yml to use this.
+
+Retrieves data from LinkShare via HTTP web service and returns simple objects:
+
+[Example]
+
+    Linkshare::Commission.find("bdate" =>"20110401", "edate" => "20110415")
+
+[Example YAML]
+
+  user_id: test_user
+  pass: secure_password
+
+Methods accept the same parameters as the LinkShare API.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/linkshare.rb

@@ -0,0 +1,6 @@
+require 'httparty'
+require 'fastercsv'
+
+directory = File.expand_path(File.dirname(__FILE__))
+require File.join(directory, "linkshare", "base")
+require File.join(directory, "linkshare", "commission")

data/lib/linkshare/base.rb

@@ -0,0 +1,84 @@
+module Linkshare
+  class Base
+    include HTTParty
+    format :xml 
+    
+    @@credentials = {}
+    @@default_params = {}
+    
+    def initialize(params)
+      raise ArgumentError, "Init with a Hash; got #{params.class} instead" unless params.is_a?(Hash)
+
+      params.each do |key, val|
+        instance_variable_set("@#{key}".intern, val)
+        instance_eval " class << self ; attr_reader #{key.intern.inspect} ; end "
+      end
+    end
+    
+    def user_id=(id)
+      @@credentials['user_id'] = id.to_s
+    end
+    
+    def pass=(pass)
+      @@credentials['pass'] = pass.to_s
+    end
+    
+    
+    class << self
+      def base_url
+        "http://cli.linksynergy.com/"
+      end
+      
+      def validate_params!(provided_params, available_params, default_params = {})
+        params = default_params.merge(provided_params)
+        invalid_params = params.select{|k,v| !available_params.include?(k.to_s)}.map{|k,v| k}
+        raise ArgumentError.new("Invalid parameters: #{invalid_params.join(', ')}") if invalid_params.length > 0
+      end
+      
+      def get_service(path, query)
+        query.keys.each{|k| query[k.to_s] = query.delete(k)}
+        query.merge!({'cuserid' => credentials['user_id'], 'cpi' => credentials['pass']})
+
+        results = []
+        
+        begin
+          response = get(path, :query => query, :timeout => 30)
+        rescue Timeout::Error
+          nil
+        end
+
+        unless validate_response(response)
+          str = response.body #+ "1x1\t36342\tAdvertiser Y\t2163\t1/31/2002\t8:58\t32\t7.99\t1\t0.39\t2/1/2002\t12:46" #dummy data
+          str = str.gsub(" \t","\t").gsub("\t\n", "\n").gsub(" ", "_").gsub("($)", "").downcase!
+          
+          results = FasterCSV.parse(str, {:col_sep => "\t", :row_sep => "\n", :headers => true})
+        end
+
+        results.map{|r| self.new(r.to_hash)}
+      end # get
+      
+      def credentials
+        unless @@credentials && @@credentials.length > 0
+          # there is no offline or test mode for CJ - so I won't include any credentials in this gem
+          config_file = ["config/linkshare.yml", File.join(ENV['HOME'], '.linkshare.yaml')].select{|f| File.exist?(f)}.first
+
+          unless File.exist?(config_file)
+            warn "Warning: config/linkshare.yaml does not exist. Put your CJ developer key and website ID in ~/.linkshare.yml to enable live testing."
+          else
+            @@credentials = YAML.load(File.read(config_file))
+          end
+        end
+        @@credentials
+      end # credentails
+      
+      def validate_response(response)
+        raise ArgumentError, "There was an error connecting to LinkShare's reporting server." if response.body.include?("REPORTING ERROR")
+      end
+      
+      def first(params)
+        find(params).first
+      end
+    
+    end # self
+  end # Base
+end # Linkshare

data/lib/linkshare/commission.rb

@@ -0,0 +1,15 @@
+module Linkshare
+  class Commission < Base
+    class << self
+      def service_url
+        base_url + "cli/publisher/reports/downloadReport.php"
+      end
+      
+      def find(params = {})
+        validate_params!(params, %w{bdate edate eid nid})
+        get_service(service_url, params)
+      end
+      
+    end # << self
+  end # class
+end # module

data/lib/linkshare/version.rb

@@ -0,0 +1,3 @@
+module Linkshare
+  VERSION = "0.0.9"
+end

data/linkshare.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "linkshare/version"
+
+Gem::Specification.new do |s|
+  s.name        = "linkshare"
+  s.version     = Linkshare::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ian Ehlert"]
+  s.email       = ["ian.ehlert@tstmedia.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby gem to hit the Linkshare report api.}
+  s.description = %q{Ruby gem to hit the Linkshare report api.}
+
+  s.rubyforge_project = "linkshare"
+
+  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_dependency(%q<httparty>)
+  s.add_dependency(%q<fastercsv>)
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: linkshare
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 9
+  version: 0.0.9
+platform: ruby
+authors: 
+- Ian Ehlert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fastercsv
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Ruby gem to hit the Linkshare report api.
+email: 
+- ian.ehlert@tstmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/linkshare.rb
+- lib/linkshare/base.rb
+- lib/linkshare/commission.rb
+- lib/linkshare/version.rb
+- linkshare.gemspec
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: linkshare
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby gem to hit the Linkshare report api.
+test_files: []
+