ihunter-whatcounts 0.3 → 0.3.1

data/lib/whatcounts/http_client.rb

@@ -0,0 +1,56 @@
+module WhatCounts
+  class HttpClient
+    
+    class InvalidConfiguration < WhatCountsError; end
+    
+    VALID_COMMANDS = [:subscribe,:update,:change,:unsubscribe,:delete,:find,
+                      :findinlist,:details,:createlist,:show_lists,:createseg,:show_seg,
+                      :update_seg,:delete_seg,:createtemplate,:show_templates,:updatetemplate,
+                      :show_user_events,:show_optout,:show_optglobal,:show_hard,:show_soft,
+                      :send,:launch,:show_campaigns,:show_campaign_stats,:show_campaign_stats_multi]
+    
+    class << self
+      # Configure the client
+      # Example:
+      # 
+      # WhatCounts::HttpClient.configure do 
+      #   api_url  "http://example.com"
+      #   realm    "client-realm"
+      #   password "superdupersecret"
+      # end
+      def configure(&block)
+        @config = Config.new
+        @config.instance_eval(&block)
+        @config
+      end
+
+      def execute(command,requestable)
+        raise InvalidConfiguration,"Invalid WhatCounts configuration, are you sure it was configured?" unless @config
+        url = [@config.api_url,"?","c=#{command}&",@config.to_param_string,"&",requestable.to_param_string].join
+        res = Curl::Easy.perform(url) do |easy|
+          easy.timeout = 8
+        end
+        WhatCounts::Response.new(url,res.body_str)
+      end
+    end
+    
+    private 
+    class Config
+      attr_accessor :api_url, :realm, :password
+      def initialize
+        # defaults
+        api_url 'http://api.whatcounts.com/bin/api_web'
+      end
+      def to_param_string
+        @param_string ||= "r=#{realm}&pwd=#{password}"
+      end
+      [:api_url,:realm,:password].each do |name|
+        eval %% 
+          def #{name}(*args) 
+            @#{name}=args.first unless args.empty?; @#{name}  
+          end        
+        %
+      end
+    end
+  end
+end

data/lib/whatcounts/list.rb

@@ -0,0 +1,69 @@
+module WhatCounts
+
+  class List
+
+    class UnknownListOptionError < WhatCountsError; end
+    class MissingRequiredListOptionError < WhatCountsError; end
+    
+    # List of all options this class accepts and their corresponding WC name.  I don't agree with 
+    # the WC naming scheme so I've renamed them to be something more semantic and meaningful
+    private
+    OPTIONS_TO_HTTP_PARAMS_MAP = {:name => :listname, :template_id => :template_id, :description => :description, 
+                                  :from_address => :from, :reply_to_address => :reply_to, :bounce_address => :error_to, 
+                                  :track_clicks => :track_clicks, :track_opens => :track_opens }
+    attr_writer *(OPTIONS_TO_HTTP_PARAMS_MAP.keys)
+
+    public
+    attr_reader *(OPTIONS_TO_HTTP_PARAMS_MAP.keys)
+    
+    # Options which are required for new/create
+    REQUIRED_OPTIONS = [:name]
+    
+    # List of options which this class will accept
+    VALID_OPTIONS = OPTIONS_TO_HTTP_PARAMS_MAP.keys
+    
+    def initialize(options)
+      options.each_key {|o| raise UnknownOptionError,"Unknown option #{o}" unless VALID_OPTIONS.include? o}
+      REQUIRED_OPTIONS.each {|o| raise MissingRequiredOptionError,"Missing required option #{o}" unless options.has_key? o}
+      options.each_pair {|k,v| self.send :"#{k}=",v}
+    end
+    
+    def create!
+      res = WhatCounts::HttpClient.execute('excreatelist',self)
+      if res.success?
+        self.instance_variable_set(:@id,res.body.to_i) 
+        return self
+      else
+        raise CreationError, res.body # this is actually the message of why it failed
+      end
+    end
+    
+    class << self
+      def create!(options)
+        o = self.new options
+        o.create!
+      end
+    end
+    
+    DEPLOY_OPTIONS_TO_HTTP_PARAMS_MAP = {:list => :list_id, :template => :template_id,
+                                         :subject => :subject, :format => :format,
+                                         :segmentation_id => :segmentation_id, :campaign_alias => :campaign_alias, 
+                                         :send_rss => :target_rss, :virtual_mta => :vmta, 
+                                         :goodmail_token => :gm_token_type, :notification_email => :notify_email }
+    DEPLOY_REQUIRED_OPTIONS = []                                     
+    def deploy!(options)
+      options.each_key {|o| raise UnknownListOptionError,"Unknown option #{o}" unless VALID_OPTIONS.include? o}
+      res = WhatCounts::HttpClient.execute('excreatelist',o)
+    end
+    
+    def id; @id end
+    def to_param_string
+      @param_string ||= OPTIONS_TO_HTTP_PARAMS_MAP.keys.inject([]) do |acc,k|
+        val = self.send :"#{k}"
+        acc << "#{OPTIONS_TO_HTTP_PARAMS_MAP[k]}=#{CGI.escape(val.to_s)}" unless val.nil?
+        acc
+      end.join("&")
+    end
+    
+  end
+end

data/lib/whatcounts/one_off_message.rb

@@ -0,0 +1,54 @@
+module WhatCounts
+  class OneOffMessage
+
+    private
+    OPTIONS_TO_HTTP_PARAMS_MAP = {:list_id => :list_id, :template_id => :template_id, :format => :format, :to => :to, :from => :from,
+                                  :subject => :subject, :body => :body, :data => :data}
+    attr_writer *(OPTIONS_TO_HTTP_PARAMS_MAP.keys)
+
+    public
+    attr_reader *(OPTIONS_TO_HTTP_PARAMS_MAP.keys)
+    REQUIRED_OPTIONS = [:list_id,:to,:format]    
+    IRREGULAR_OPTIONS = [:data]
+    VALID_OPTIONS = OPTIONS_TO_HTTP_PARAMS_MAP.keys
+    
+    def initialize(options)
+      options.each_key {|o| raise UnknownOptionError,"Unknown option #{o}" unless VALID_OPTIONS.include? o}
+      REQUIRED_OPTIONS.each {|o| raise MissingRequiredOptionError,"Missing required option #{o}" unless options.has_key? o}
+      options.each_pair {|k,v| self.send :"#{k}=",v}
+    end
+
+    def send!
+      WhatCounts::HttpClient.execute('send',self)
+    end
+    
+    class << self
+      def send!(options)
+        self.new(options).send!
+      end
+    end
+    
+    def to_param_string
+      @param_string ||= begin
+        pairs = (OPTIONS_TO_HTTP_PARAMS_MAP.keys-IRREGULAR_OPTIONS).inject([]) do |acc,k|
+          val = self.send :"#{k}"
+          acc << "#{OPTIONS_TO_HTTP_PARAMS_MAP[k]}=#{CGI.escape(val.to_s)}" unless val.nil?
+          acc
+        end
+        unless self.data.nil?
+          if self.data.kind_of? String
+            pairs << "data=#{CGI.escape(self.data)}"
+          elsif self.data.kind_of? Hash
+            data_pairs = self.data.inject([[],[]]){|acc,(k,v)| acc[0]<<k;acc[1]<<v;acc}
+            data_field = "#{data_pairs[0].join(',')}^#{data_pairs[1].join(',')}"
+            pairs << "data=#{CGI.escape(data_field)}"
+          else 
+            # TODO i duno what to do here, probably error?  Maybe not since the param isn't required
+          end
+        end       
+        pairs
+      end.join("&")
+    end
+    
+  end
+end

data/lib/whatcounts/rails/mailer.rb

@@ -0,0 +1,15 @@
+module WhatCounts
+  module Rails
+    class Mailer
+  
+      if Object.const_defined?(:ActionController)
+        include ActionController::UrlWriter
+        include ActionView::Helpers::AssetTagHelper
+        include ActionView::Helpers::TagHelper
+      end
+  
+      include Helpers
+  
+    end
+  end
+end

data/lib/whatcounts/response.rb

@@ -0,0 +1,32 @@
+module WhatCounts
+  class Response
+    
+    SUCCESS = true
+    FAILURE = false
+    
+    attr_reader :result, :body
+    private
+      attr_writer :result, :body
+    
+    public 
+    
+    def initialize(url,document)
+      if document =~ /^(SUCCESS|FAILURE):?(.*)/
+        # simple response
+        self.body = $2.strip
+        case $1 
+        when "SUCCESS"
+          self.result = SUCCESS
+        when "FAILURE"
+          self.result = FAILURE
+        end
+      else
+        # TODO data based response
+        self.body = document
+      end
+    end
+    
+    def success?; self.result end
+    def failure?; !self.result end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ihunter-whatcounts
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: 0.3.1
 platform: ruby
 authors: 
 - Ian Hunter
@@ -43,6 +43,11 @@ files:
 - script/console
 - script/destroy
 - script/generate
+- lib/whatcounts/http_client.rb
+- lib/whatcounts/list.rb
+- lib/whatcounts/one_off_message.rb
+- lib/whatcounts/response.rb
+- lib/whatcounts/rails/mailer.rb
 has_rdoc: false
 homepage: http://github.com/ihunter/whatcounts
 post_install_message: PostInstall.txt