aweber 1.0.0

data/lib/aweber/oauth.rb

@@ -0,0 +1,69 @@
+module AWeber
+  class OAuth
+    extend Forwardable
+
+    def_delegators :access_token, :get, :post, :put, :delete
+
+    attr_accessor :callback_url
+
+    def initialize(consumer_token, consumer_secret, options={})
+      @consumer_token  = consumer_token
+      @consumer_secret = consumer_secret
+      @callback_url    = options[:callback_url]
+    end
+
+    def consumer
+      @consumer ||= ::OAuth::Consumer.new(@consumer_token, @consumer_secret, {
+        :site               => AWeber.auth_endpoint,
+        :request_token_path => "/#{AWeber::AUTH_VERSION}/oauth/request_token",
+        :authorize_path     => "/#{AWeber::AUTH_VERSION}/oauth/authorize",
+        :access_token_path  => "/#{AWeber::AUTH_VERSION}/oauth/access_token",
+        :scheme             => :query_string
+      })
+    end
+
+    # Retrieve a Request Token or simply return it, if it already exists.
+    #
+    # @param [Hash] options OAuth parameters. +:oauth_callback+ for example
+    #
+    def request_token(options={})
+      @request_token ||= consumer.get_request_token(options)
+    end
+
+    # Get an Access Token from a Request Token using the 
+    # +verifier+ code.
+    #
+    # @param [String] verifier Verification code retrieved from 
+    #                          user authentication
+    #
+    def authorize_with_verifier(verifier)
+      token = request_token.get_access_token(:oauth_verifier => verifier)
+      @access_token_key    = token.token
+      @access_token_secret = token.secret
+      access_token
+    end
+
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(consumer, @access_token_key,
+        @access_token_secret)
+    end
+
+    # Authorize with an Access Token key and secret you've previously
+    # retrieved via a user authentication.
+    #
+    # @param [String] access_token_key Access Token key
+    # @param [String] access_token_secret Access Token secret
+    #
+    def authorize_with_access(access_token_key, access_token_secret)
+      @access_token_key    = access_token_key
+      @access_token_secret = access_token_secret
+    end
+
+    # Remove any active token instances and start over
+    #
+    def clear_tokens
+      @request_token = nil
+      @access_token  = nil
+    end
+  end
+end

data/lib/aweber/resource.rb

@@ -0,0 +1,93 @@
+module AWeber
+  # Base class for all entries. All resources have the following attributes:
+  #
+  # - +id+
+  # - +http_etag+ (aliased as +etag+)
+  # - +self_link+ (aliased as +link+)
+  # - +resource_type_link+ (aliased as +resource_type+)
+  #
+  # Resources also have attributes based on their the type of resource it is.
+  # To see a full list of attributes per resource, visit
+  # http://labs.aweber.com/docs/reference/1.0/reference.
+  #
+  class Resource
+    extend Forwardable
+    include Comparable
+
+    def_delegators :client, :get
+
+    class << self
+      # Works the same as +alias_method+, but for attributes created via
+      # +attr*+ methods.
+      #
+      def alias_attribute(alias_, attribute)
+        alias_method alias_, attribute
+      end
+      
+      def has_one(name)
+        define_method(name) do
+          ivar = instance_variable_get("@#{name}")
+          return ivar if ivar
+          
+          resource_link = instance_variable_get("@#{name}_link")
+          klass         = AWeber.get_class(:"#{name}s")
+          collection    = klass.new(client, get(resource_link))
+          instance_variable_set("@#{name}", collection)
+        end
+      end
+
+      # Creates a lazy loaded method which will retrieve and create a 
+      # collection of +name+ of objects.
+      #
+      # @param [Symbol] name name of the collection method
+      # @return [AWeber::Collection] Collection of +name+ objects
+      #
+      # @example
+      #   class Account
+      #     attr_reader :lists_collection_link
+      #     collection  :lists
+      #   end
+      #
+      #   #=> Account.new(...).lists #=> <AWeber::Collection>
+      #
+      def has_many(name)
+        define_method(name) do
+          ivar = instance_variable_get("@#{name}")
+          return ivar if ivar
+
+          resource_link = instance_variable_get("@#{name}_collection_link")
+          klass         = AWeber.get_class(name)
+          collection    = Collection.new(client, klass, get(resource_link))
+          instance_variable_set("@#{name}", collection)
+        end
+      end
+    end
+
+    attr_reader :id
+    attr_reader :http_etag
+    attr_reader :self_link
+    attr_reader :resource_type_link
+
+    alias_attribute :etag, :http_etag
+    alias_attribute :link, :self_link
+    alias_attribute :resource_type, :resource_type_link
+
+    def initialize(client, data={})
+      @client = client
+      data.each do |key, value|
+        instance_variable_set("@#{key}", value) if respond_to? key
+      end
+    end
+
+    def <=>(other)
+      @id <=> other.id
+    end
+
+  private
+
+    def client
+      @client
+    end
+
+  end
+end

data/lib/aweber/resources.rb

@@ -0,0 +1,14 @@
+require "aweber/resources/account"
+require "aweber/resources/broadcast"
+require "aweber/resources/click"
+require "aweber/resources/followup"
+require "aweber/resources/link"
+require "aweber/resources/list"
+require "aweber/resources/message"
+require "aweber/resources/open"
+require "aweber/resources/subscriber"
+require "aweber/resources/tracked_event"
+require "aweber/resources/integration"
+require "aweber/resources/web_form"
+require "aweber/resources/web_form_split_test"
+require "aweber/resources/web_form_split_test_component"

data/lib/aweber/resources/account.rb

@@ -0,0 +1,14 @@
+module AWeber
+  module Resources
+    class Account < Resource
+      attr_reader :lists_collection_link
+      attr_reader :integrations_collection_link
+    
+      has_many :lists
+      has_many :integrations
+    
+      alias_attribute :etag, :http_etag
+      alias_attribute :uri, :self_link
+    end
+  end
+end

data/lib/aweber/resources/broadcast.rb

@@ -0,0 +1,29 @@
+module AWeber
+  module Resources
+    class Broadcast < Resource
+      attr_reader :click_tracking_enabled
+      attr_reader :content_type
+      attr_reader :is_archived
+      attr_reader :scheduled_at
+      attr_reader :sent_at
+      attr_reader :spam_assassin_score
+      attr_reader :subject
+      attr_reader :total_clicks
+      attr_reader :total_opens
+      attr_reader :total_sent
+      attr_reader :total_spam_complaints
+      attr_reader :total_undelivered
+      attr_reader :total_unsubscribes
+      attr_reader :twitter_account_link
+
+      attr_reader :links_collection_link
+      attr_reader :messages_collection_link
+
+      has_many :links
+      has_many :messages
+
+      alias_attribute :is_archived?, :is_archived
+      alias_attribute :is_click_tracking_enabled?, :click_tracking_enabled
+    end
+  end
+end

data/lib/aweber/resources/click.rb

@@ -0,0 +1,13 @@
+module AWeber
+  module Resources
+    class Click < Resource
+      attr_reader :event_time
+      attr_reader :is_earliest
+      attr_reader :subscriber_link
+      
+      has_one :subscriber
+      
+      alias_attribute :is_earliest?, :is_earliest
+    end
+  end
+end

data/lib/aweber/resources/followup.rb

@@ -0,0 +1,24 @@
+module AWeber
+  module Resources
+    class Followup < Resource
+      attr_reader :click_tracking_enabled
+      attr_reader :content_type
+      attr_reader :message_interval
+      attr_reader :message_number
+      attr_reader :spam_assassin_score
+      attr_reader :subject
+      attr_reader :total_clicked
+      attr_reader :total_opened
+      attr_reader :total_sent
+      attr_reader :total_spam_complaints
+      attr_reader :total_undelivered
+      attr_reader :total_unsubscribes
+      
+      attr_reader :links_collection_link
+      attr_reader :messages_collection_link
+      
+      has_many :links
+      has_many :messages
+    end
+  end
+end

data/lib/aweber/resources/integration.rb

@@ -0,0 +1,8 @@
+module AWeber
+  module Resources
+    class Integration < Resource
+      attr_reader :login
+      attr_reader :service_name
+    end
+  end
+end

data/lib/aweber/resources/link.rb

@@ -0,0 +1,12 @@
+module AWeber
+  module Resources
+    class Link < Resource
+      attr_reader :total_clicks
+      attr_reader :total_unique_clicks
+      attr_reader :url
+      attr_reader :clicks_collection_link
+      
+      has_many :clicks
+    end
+  end
+end

data/lib/aweber/resources/list.rb

@@ -0,0 +1,86 @@
+module AWeber
+  module Resources
+    class List < Resource
+      FOLLOWUP_TYPE_LINK  = File.join(AWeber.api_url, "#followup_campaign")
+      BROADCAST_TYPE_LINK = File.join(AWeber.api_url, "#broadcast_campaign")
+      
+      attr_reader :name
+      
+      attr_reader :campaigns_collection_link
+      attr_reader :subscribers_collection_link
+      attr_reader :web_forms_collection_link
+      attr_reader :web_form_split_tests_collection_link
+      
+      has_many :subscribers
+      has_many :web_forms
+      has_many :web_form_split_tests
+      
+      def initialize(*args)
+        super(*args)
+        @campaigns  = {}
+        @followups  = nil
+        @broadcasts = nil
+      end
+      
+      def campaigns
+        return @campaigns unless @campaigns == {}
+        create_followups
+        create_broadcasts
+        populate_campaigns
+        @campaigns
+      end
+      
+      def broadcasts
+        campaigns if @broadcasts.nil?
+        @broadcasts
+      end
+      
+      def followups
+        campaigns if @followups.nil?
+        @followups
+      end
+      
+    private
+      
+      def create_followups
+        followups  = _entries.select { |entry| is_followup? entry }
+        @followups = Collection.new(client, Followup, {
+          "entries"            => followups, 
+          "total_size"         => followups.length,
+          "resource_type_link" => FOLLOWUP_TYPE_LINK
+        })
+      end
+      
+      def create_broadcasts
+        broadcasts  = _entries.select { |entry| is_broadcast? entry }
+        @broadcasts = Collection.new(client, Broadcast, {
+          "entries"            => broadcasts, 
+          "total_size"         => broadcasts.length,
+          "resource_type_link" => BROADCAST_TYPE_LINK
+        })
+      end
+      
+      def populate_campaigns
+        @followups.each  { |id, followup|  @campaigns[id] = followup  }
+        @broadcasts.each { |id, broadcast| @campaigns[id] = broadcast }
+      end
+      
+      def is_followup?(entry)
+        entry["resource_type_link"].split("#").last =~ /^followup/
+      end
+      
+      def is_broadcast?(entry)
+        entry["resource_type_link"].split("#").last =~ /^broadcast/
+      end
+      
+      def _campaigns
+        @_campaigns ||= get(@campaigns_collection_link)
+      end
+      
+      def _entries
+        _campaigns["entries"]
+      end
+      
+    end
+  end
+end

data/lib/aweber/resources/message.rb

@@ -0,0 +1,20 @@
+module AWeber
+  module Resources
+    class Message < Resource
+      attr_reader :event_time
+      attr_reader :last_opened
+      attr_reader :total_opens
+      
+      attr_reader :subscriber_link
+      attr_reader :tracked_events_collection_link
+      attr_reader :opens_collection_link
+      
+      has_one :subscriber
+      
+      has_many :tracked_events
+      has_many :opens
+      
+      alias_attribute :events, :tracked_events
+    end
+  end
+end

data/lib/aweber/resources/open.rb

@@ -0,0 +1,10 @@
+module AWeber
+  module Resources
+    class Open < Resource
+      attr_reader :event_time
+      attr_reader :subscriber_link
+      
+      has_one :subscriber
+    end
+  end
+end

data/lib/aweber/resources/subscriber.rb

@@ -0,0 +1,26 @@
+module AWeber
+  module Resources
+    class Subscriber < Resource
+      attr_reader :ad_tracking
+      attr_reader :email
+      attr_reader :ip_address
+      attr_reader :is_verified
+      attr_reader :last_followup_sent_at
+      attr_reader :misc_notes
+      attr_reader :name
+      attr_reader :status
+      attr_reader :subscribed_at
+      attr_reader :subscription_method
+      attr_reader :subscription_url
+      attr_reader :unsubscribed_at
+      attr_reader :verified_at
+      
+      attr_reader :last_followup_sent_link
+      
+      has_one :last_followup_sent
+      
+      alias_attribute :is_verified?, :is_verified
+      alias_attribute :notes, :misc_notes
+    end
+  end
+end

data/lib/aweber/resources/tracked_event.rb

@@ -0,0 +1,13 @@
+module AWeber
+  module Resources
+    class TrackedEvent < Resource
+      attr_reader :event_time
+      attr_reader :type
+      attr_reader :subscriber_link
+      
+      has_one :subscriber
+    
+      alias_attribute :time, :event_time
+    end
+  end
+end