streamsend 0.2.3 → 1.0.0.rc1

data/.gitignore

@@ -1,5 +1,18 @@
-.DS_Store
-tags
-spec/integration/integration.yml
-.git-commit-story.yml
-logfile.log
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -1 +1,2 @@
 --color
+--format progress

data/Gemfile

@@ -1,3 +1,4 @@
-source "https://rubygems.org"
+source "http://rubygems.org"
 
+# Specify your gem's dependencies in streamsend-ruby.gemspec
 gemspec

data/Gemfile.lock

@@ -1,42 +1,52 @@
 PATH
   remote: .
   specs:
-    streamsend (0.2.2)
+    streamsend (1.0.0.rc1)
       activesupport (~> 3.2)
       builder
-      httparty
+      httmultiparty
 
 GEM
-  remote: https://rubygems.org/
+  remote: http://rubygems.org/
   specs:
     activesupport (3.2.14)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     addressable (2.3.5)
     builder (3.2.2)
+    columnize (0.3.6)
     crack (0.4.0)
       safe_yaml (~> 0.9.0)
     diff-lcs (1.2.4)
     git-commit-story (0.1.5)
+    httmultiparty (0.3.10)
+      httparty (>= 0.7.3)
+      multipart-post
     httparty (0.11.0)
       multi_json (~> 1.0)
       multi_xml (>= 0.5.2)
     i18n (0.6.5)
-    multi_json (1.8.0)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    multi_json (1.8.1)
     multi_xml (0.5.5)
+    multipart-post (1.2.0)
     pair-salad (0.1.1)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    rbx-require-relative (0.0.9)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    ruby-fsevent (0.2.1)
+    rspec-mocks (2.14.3)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
     safe_yaml (0.9.3)
-    vcr (2.5.0)
-    watchr (0.7)
     webmock (1.12.3)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
@@ -48,8 +58,6 @@ DEPENDENCIES
   git-commit-story
   pair-salad
   rspec
-  ruby-fsevent
+  ruby-debug
   streamsend!
-  vcr
-  watchr
   webmock (~> 1.6)

data/README.md

@@ -0,0 +1,76 @@
+# streamsend-ruby
+
+streamsend-ruby is a thin ruby wrapper for the StreamSend API.
+
+### Getting started
+
+**Creating a session**
+Credentials can be passed in when initializing the session:
+
+    Session::Api::Session.new("my_ss_api_username", "secret_api_password")
+
+Set via environment variables:
+
+    export STREAMSEND_USERNAME="my_ss_api_username"
+    export STREAMSEND_PASSWORD="secret_api_password"
+
+Set via config file (gem checks for config/streamsend-ruby.yml):
+
+    root_account:
+      username: "my_ss_api_username"
+      password: "secret_api_password"
+
+The base_uri can also be set in the same ways (e.g. STREAMSEND_BASE_URI="http://my.branded.url", and base_uri:
+"http://my.branded.url"), but is optional and defaults to
+<https://app.streamsend.com>
+
+**Making Calls**
+
+The show and index calls return a single or array of StreamSend::Api::Result
+objects. The StreamSend::Api::Result object is just an OpenStruct that responds
+to id with the hash value of id rather than the Ruby id. It also has to_hash
+defined as an alias to marshaldump. Create and update take an object hash of
+whatever it is that you're creating/updating. The object values should be nested
+in a hash with a key corresponding to the object type:
+
+`{ :list => { :name => "This is my new list!" } }`
+
+OR
+
+    { :list => my_list_result_object.to_hash }
+    #working with a result object named my_list_result_object.
+
+### Examples:
+
+**Index**
+
+    #Assuming credentials are set in env variables or in config file...
+    session = StreamSend::Api::Session.new()
+    index_call = StreamSend::Api::List::Index.new(session)
+    #Getting an array of StreamSend::Api::Result objects that respond like lists
+    lists =index_call.execute
+
+**Create**
+
+    session = StreamSend::Api::Session.new()
+    create_call =StreamSend::Api::List::Create.new(session)
+    list_id = create_call.execute(:list => {:name => "new list!"})
+
+**Show**
+
+    session = StreamSend::Api::Session.new("ss_api_username", "ss_api_pasword")
+    show_call = StreamSend::Api::List.Show.new(session)
+    list = show_call.execute(list_id)
+
+**Destroy**
+
+    session = StreamSend::Api::Session.new("ss_api_username", "ss_api_pasword")
+    destroy_call = StreamSend::Api::List.Destroy.new(session)
+    destroy_call.execute(list_id)
+    #returns a bool indicating if it was destroyed
+
+**Update**
+
+    session = StreamSend::Api::Session.new()
+    update_call = StreamSend::Api::List::Update.new(session)
+    update_call.execute(list_id, :list => {:name => "updated list!"})

data/Rakefile

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

data/lib/streamsend/api/account.rb

@@ -1,61 +1,19 @@
-require "active_support/core_ext/hash"
-require File.expand_path(__FILE__, "exception")
-
 module StreamSend
   module Api
-    class Account < Resource
-      def self.all
-        response = StreamSend::Api.get("/accounts.xml")
-
-        case response.code
-        when 200
-          response["accounts"].collect { |data| new(data) }
-        else
-          raise StreamSend::Api::Exception.new("Could not find any accounts. Make sure your api username and password are correct. (#{response.code})")
-        end
+    module Account
+      class Index < StreamSend::Api::Call::Index
       end
 
-      def self.show(id)
-        response = StreamSend::Api.get("/accounts/#{id}.xml")
-        case response.code
-        when 200
-          new(response["account"])
-        else
-          raise StreamSend::Api::Exception.new("Could not find the account. Make sure your account ID is correct. (#{response.code})")
-        end
+      class Show < StreamSend::Api::Call::Show
       end
 
-      def self.update(account_hash)
-        response = StreamSend::Api.put("/accounts/#{account_hash['account_id']}/users/#{account_hash['user_id']}.xml", :body => account_hash.to_xml)
-        case response.code
-        when 200
-          true
-        else
-          false
-        end
+      class Update < StreamSend::Api::Call::Update
       end
 
-      def self.create(account_hash)
-        response = StreamSend::Api.post("/accounts.xml", :body => {:account => account_hash})
-        case response.code
-        when 201
-          response.headers["location"] =~ %r(/accounts/(\d+))
-          account_id = $1
-          account_id.to_i
-        else
-          raise StreamSend::Api::Exception.new("Could not create the account. (#{response.code})")
-        end
+      class Destory < StreamSend::Api::Call::Destroy
       end
 
-      def self.destroy(id)
-        id = id.to_i
-        response = StreamSend::Api.delete("/accounts/#{id}.xml")
-        case response.code
-        when 200
-          true
-        else
-          raise StreamSend::Api::Exception.new("Could not delete the account. (#{response.code})")
-        end
+      class Create < StreamSend::Api::Call::Create
       end
     end
   end

data/lib/streamsend/api/audience.rb

@@ -0,0 +1,14 @@
+module StreamSend
+  module Api
+    class Audience
+      class Index < StreamSend::Api::Call::Index
+      end
+
+      class Show < StreamSend::Api::Call::Show
+      end
+
+      class Update < StreamSend::Api::Call::Update
+      end
+    end
+  end
+end

data/lib/streamsend/api/base/base_call.rb

@@ -0,0 +1,60 @@
+module StreamSend
+  module Api
+    module Call
+      class BaseCall
+        def initialize(session)
+          @session = session
+        end
+
+        def session
+          @session
+        end
+
+        def namespace
+          namespaces = self.class.name.split("::")
+          namespaces[namespaces.count - 2].tableize.downcase
+        end
+
+        def base_uri
+          "#{session.base_uri}/#{namespace}"
+        end
+
+        def base_audience_only
+          "#{session.base_uri}/audiences/#{session.audience_id}"
+        end
+
+        def base_blast_only_for blast_id
+          "#{session.base_uri}/blasts/#{blast_id}"
+        end
+
+        def base_audience_uri
+          "#{session.base_uri}/audiences/#{session.audience_id}/#{namespace}"
+        end
+
+        def base_blast_uri_for blast_id
+          "#{session.base_uri}/blasts/#{blast_id}/#{namespace}"
+        end
+
+        def user_uri_for(account_id, user_id)
+          "#{session.base_uri}/accounts/#{account_id}/users/#{user_id}.xml"
+        end
+
+        def users_uri account_id
+          "#{session.base_uri}/accounts/#{account_id}/users.xml"
+        end
+
+        def blast_uri_for blast_id
+          "#{base_blast_uri_for(blast_id)}.xml"
+        end
+
+        def audience_uri_for id
+          "#{base_audience_uri}/#{id}.xml"
+        end
+
+        def audiences_uri
+          "#{base_audience_uri}.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/base/create.rb

@@ -0,0 +1,41 @@
+module StreamSend
+  module Api
+    module Call
+      class Create < StreamSend::Api::Call::BaseCall
+        def execute(object_hash, options = {})
+          options.merge!(:body => object_hash)
+          response = session.post(uri, options)
+          case response.code
+          when 201
+            response.headers["location"].split("/").last.to_i
+          when 422
+            raise StreamSend::Api::SemanticException.new(response["errors"]["error"])
+          else
+            raise StreamSend::Api::Exception.new("Could not create the #{namespace}. (#{response.code})")
+          end
+        end
+
+        def uri
+          "#{base_uri}.xml"
+        end
+      end
+
+      class AudienceCreate < StreamSend::Api::Call::Create
+        def uri
+          audiences_uri
+        end
+      end
+
+      class BlastCreate < StreamSend::Api::Call::Create
+        def execute(blast_id, object_hash)
+          @blast_id = blast_id
+          super(object_hash)
+        end
+
+        def uri
+          blast_uri_for @blast_id
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/base/destroy.rb

@@ -0,0 +1,43 @@
+module StreamSend
+  module Api
+    module Call
+      class Destroy < StreamSend::Api::Call::BaseCall
+        def execute(object_id)
+          @id = object_id
+          response = session.delete(uri)
+          case response.code
+          when 200
+            true
+          else
+            raise StreamSend::Api::Exception.new "Could not delete #{namespace}. (#{response.code})"
+          end
+        end
+
+        def uri
+          "#{base_uri}/#{id}.xml"
+        end
+
+        def id
+          @id
+        end
+      end
+
+      class AudienceDestroy < StreamSend::Api::Call::Destroy
+        def uri
+          audience_uri_for id
+        end
+      end
+
+      class BlastDestroy < StreamSend::Api::Call::Destroy
+        def execute(blast_id, object_id)
+          @blast_id = blast_id
+          super(object_id)
+        end
+
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/#{id}.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/base/index.rb

@@ -0,0 +1,51 @@
+module StreamSend
+  module Api
+    module Call
+      class Index < StreamSend::Api::Call::BaseCall
+        def execute(index_options = {})
+          @options = index_options
+          response = session.get(uri, @options)
+          case response.code
+          when 200
+            response.parsed_response[namespace].collect { |data| StreamSend::Api::Result.new(data) }
+          else
+            raise StreamSend::Api::Exception.new("Could not find any #{namespace}. (#{response.code})")
+          end
+        end
+
+        def uri
+          "#{base_uri}.xml"
+        end
+
+        def paging_query_string
+          "?page=#{page}&per_page=#{per_page}"
+        end
+
+        def page
+          @options[:page] || 1
+        end
+
+        def per_page
+          @options[:per_page] || StreamSend::PER_PAGE_DEFAULT
+        end
+      end
+
+      class AudienceIndex < StreamSend::Api::Call::Index
+        def uri
+          audiences_uri
+        end
+      end
+
+      class BlastIndex < StreamSend::Api::Call::Index
+        def execute(blast_id, index_options = {})
+          @blast_id = blast_id
+          super(index_options)
+        end
+
+        def uri
+          "#{blast_uri_for(@blast_id)}#{paging_query_string}"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/base/show.rb

@@ -0,0 +1,42 @@
+module StreamSend
+  module Api
+    module Call
+      class Show < StreamSend::Api::Call::BaseCall
+        def execute(object_id)
+          @id = object_id
+          response = session.get(uri)
+          case response.code
+          when 200
+            StreamSend::Api::Result.new(response.parsed_response[namespace.singularize])
+          else
+            raise StreamSend::Api::Exception.new("Could not find any #{namespace} with the specified id. (#{response.code})")
+          end
+        end
+
+        def uri
+          "#{base_uri}/#{id}.xml"
+        end
+
+        def id
+          @id
+        end
+      end
+
+      class AudienceShow < StreamSend::Api::Call::Show
+        def uri
+          audience_uri_for id
+        end
+      end
+
+      class BlastShow < StreamSend::Api::Call::Show
+        def execute(blast_id, object_id)
+          @blast_id = blast_id
+          super(object_id)
+        end
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/#{id}.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/base/update.rb

@@ -0,0 +1,43 @@
+module StreamSend
+  module Api
+    module Call
+      class Update < StreamSend::Api::Call::BaseCall
+        def execute(object_id, object_hash)
+          @id = object_id
+          response = session.put(uri, :body => object_hash)
+          case response.code
+          when 200
+            true
+          else
+            false
+          end
+        end
+
+        def uri
+          "#{base_uri}/#{@id}.xml"
+        end
+
+        def id
+          @id
+        end
+      end
+
+      class AudienceUpdate < StreamSend::Api::Call::Update
+        def uri
+          audience_uri_for id
+        end
+      end
+
+      class BlastUpdate < StreamSend::Api::Call::Update
+        def execute(blast_id, object_id, object_hash)
+          @blast_id = blast_id
+          super(object_id, object_hash)
+        end
+
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/#{id}.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/blast.rb

@@ -0,0 +1,51 @@
+module StreamSend
+  module Api
+    module Blast
+      class Index < StreamSend::Api::Call::AudienceIndex
+        def uri
+          "#{audiences_uri}#{paging_query_string}"
+        end
+      end
+
+      class Scheduled < StreamSend::Api::Call::AudienceIndex
+        def uri
+          "#{base_audience_uri}/scheduled.xml#{paging_query_string}"
+        end
+      end
+
+      class Sent < StreamSend::Api::Call::AudienceIndex
+        def uri
+          "#{base_audience_uri}/sent.xml#{paging_query_string}"
+        end
+      end
+
+      class Show < StreamSend::Api::Call::AudienceShow
+      end
+
+      class Update < StreamSend::Api::Call::AudienceUpdate
+      end
+
+      class Destroy < StreamSend::Api::Call::AudienceDestroy
+      end
+
+      class Create < StreamSend::Api::Call::AudienceCreate
+      end
+
+      class Test < StreamSend::Api::Call::AudienceCreate
+        def execute(blast_hash)
+          response = session.post(uri, :body => blast_hash)
+          return response.code if response.code == 200
+          if response.code == 422
+            raise StreamSend::Api::SemanticException.new(response["errors"]["error"])
+          else
+            raise StreamSend::Api::Exception.new("Could not send test blast. (#{response.code})")
+          end
+        end
+
+        def uri
+          "#{base_audience_uri}/test.xml"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/bounce.rb

@@ -0,0 +1,20 @@
+module StreamSend
+  module Api
+    module  Bounce
+      class Index < StreamSend::Api::Call::BlastIndex
+      end
+
+      class Soft < StreamSend::Api::Call::BlastIndex
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/soft.xml#{paging_query_string}"
+        end
+      end
+
+      class Hard < StreamSend::Api::Call::BlastIndex
+        def uri
+          "#{base_blast_uri_for(@blast_id)}/hard.xml#{paging_query_string}"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/click.rb

@@ -0,0 +1,18 @@
+module StreamSend
+  module Api
+    module Click
+      class Index < StreamSend::Api::Call::Index
+        def execute(blast_id, link_id = nil, options = {})
+          @blast_id = blast_id
+          @link_id = link_id if link_id
+          super(options)
+        end
+
+        def uri
+          return "#{base_blast_only_for(@blast_id)}/links/#{@link_id}/clicks.xml#{paging_query_string}" if @link_id
+          "#{base_blast_uri_for(@blast_id)}.xml#{paging_query_string}"
+        end
+      end
+    end
+  end
+end

data/lib/streamsend/api/configuration.rb

@@ -0,0 +1,26 @@
+module StreamSend
+  module Api
+    class Configuration
+      def self.config
+        @config ||= load_config_file
+      end
+
+      def self.load_config_file
+        file_path = "config/streamsend-ruby.yml"
+        return YAML.load(ERB.new(IO.read(file_path)).result) if File.file?(file_path)
+      end
+
+      def self.username
+        config["root_account"]["username"] if config
+      end
+
+      def self.password
+        config["root_account"]["password"] if config
+      end
+
+      def self.base_uri
+        config["root_account"]["base_uri"] if config
+      end
+    end
+  end
+end