streamsend 1.0.0.rc16 → 1.0.0.rc19

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmY1MDIyZThjMDUxODE1ZmYyMzViNjliMWJlYTVmZDg2NzA0NTY1ZQ==
+    YjU4NDE1YWQyOWQzNzVhNTA1OTFmNTMwYjU0NGU0MDU3Y2E0Y2UzYw==
   data.tar.gz: !binary |-
-    ODQxZWFmMjg2M2EzMWZlODhmYjMzYTQyMzRjMzFhN2I3OGEzZTA5ZQ==
+    N2Q5MWQwNjIxYWRhYWYyYWQzNjQyNWY4MzIwMjU5NjhlNzBhN2RjNw==
 SHA512:
   metadata.gz: !binary |-
-    M2FiNTlmZDhmMTU5MDhlMjQwY2MxZWQxMDI0ZWNiNDg2Mjg4MTkzNWE5ZDZi
-    MzI5YTM0ZGFlYWQ5N2IxNTQ2NjEwY2E1OTUwMDI5ZTJlNGM5M2NiMTUxZTM5
-    MjY5MWNkZDBhOTZhMjBmN2I5YjFlNGIzMDhjYTc1MjQxY2VjNTQ=
+    NzMwMTI3MjVjMTBmYTM3YTA4OTkxYTBlMzU0MDlkMzg1N2NjODU1ZTYxZDUy
+    NGE2MmMxNDA5Yzg1M2M3M2FmNzkxZmM4ZDVmZTE2MDk3ODM5MzFmYWU1MDgz
+    YjUyYjI2OWFmNTdiZTZlZGViNzA2ZmIyNDQyYjQ1ZjkxNzQ5N2E=
   data.tar.gz: !binary |-
-    NzNmNDEyNDdiODUzZGVhNTY4N2ZjYzExODc5NjFjNmMwNzIwN2IxNWIyYjk4
-    MWY5NTkwMmFlYzlhYWMzYWViMThhNjgxMjJhNDkyNDQyMzk3NDg1ZGI2OGI4
-    NTczMjAzOTBlMWZlNjhhOThiNTNjNDAwOThjNTI3NjBiNzBiNDg=
+    YmRhMmRlNDk0ZThlMjJkZWUyODk4Zjg5ODM2YjMxZmRlNzgzODlkMTU4YzYz
+    MTg5ZDlmNTAyMDJlNzkyNjQwZTgxZTIxMDQ3NjM4ZGZiOGFlZDNlYTFkZGRm
+    ZjYyZmE5YTBlZWI3ODQxY2JkMmJlZjkwMDlhOWRlZWMyYTRkZTA=

data/.gitignore

@@ -12,6 +12,8 @@ test/tmp
 test/version_tmp
 tmp
 config/streamsend-ruby.yml
+test.txt
+tags
 
 # YARD artifacts
 .yardoc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    streamsend (1.0.0.rc15)
+    streamsend (1.0.0.rc18)
       activesupport (~> 3.2)
       builder
       httmultiparty
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.2.15)
+    activesupport (3.2.17)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     addressable (2.3.5)
@@ -25,17 +25,19 @@ GEM
     debugger-ruby_core_source (1.2.3)
     diff-lcs (1.2.4)
     git-commit-story (0.1.5)
-    httmultiparty (0.3.10)
+    httmultiparty (0.3.14)
       httparty (>= 0.7.3)
+      mimemagic
       multipart-post
-    httparty (0.12.0)
+    httparty (0.13.1)
       json (~> 1.8)
       multi_xml (>= 0.5.2)
-    i18n (0.6.5)
+    i18n (0.6.9)
     json (1.8.1)
-    multi_json (1.8.2)
+    mimemagic (0.2.1)
+    multi_json (1.9.2)
     multi_xml (0.5.5)
-    multipart-post (1.2.0)
+    multipart-post (2.0.0)
     pair-salad (0.1.1)
     rake (10.1.0)
     rspec (2.14.1)

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

@@ -0,0 +1,27 @@
+require "open-uri"
+
+module StreamSend
+  module Api
+    module Call
+      class Count < StreamSend::Api::Call::BaseCall
+        def execute()
+          response = session.get(uri)
+          case response.code
+          when 200
+            response.parsed_response["count"]
+          when 400
+            raise StreamSend::Api::ApiException.new(get_error_from(response))
+          when 401
+            raise StreamSend::Api::UnauthorizedException.new("Please check your credentials and host: " + session.base_uri)
+          else
+            raise StreamSend::Api::Exception.new("Could not return count of #{namespace}. (#{response.code})")
+          end
+        end
+
+        def uri
+          "#{base_uri}/count.xml"
+        end
+      end
+    end
+  end
+end

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

@@ -5,11 +5,13 @@ module StreamSend
     module Call
       class Index < StreamSend::Api::Call::BaseCall
         def execute(index_options = {})
-          @options = index_options
-          response = session.get(uri, @options)
+          options = build_query_with(index_options)
+          response = session.get(uri, options)
           case response.code
           when 200
             response.parsed_response[namespace].collect { |data| StreamSend::Api::Result.new(data) }
+          when 400
+            raise StreamSend::Api::ApiException.new(get_error_from(response))
           when 401
             raise StreamSend::Api::UnauthorizedException.new("Please check your credentials and host: " + session.base_uri)
           else
@@ -17,20 +19,16 @@ module StreamSend
           end
         end
 
-        def uri
-          (@options[:page]) ? "#{base_uri}.xml#{paging_query_string}" : "#{base_uri}.xml"
-        end
-
-        def paging_query_string
-          "?page=#{page}&per_page=#{per_page}"
-        end
-
-        def page
-          @options[:page] || 1
+        def build_query_with(options)
+          if (options[:query].nil? && options[:headers].nil? && !options.empty?)
+            {:query => options}
+          else
+            options
+          end
         end
 
-        def per_page
-          @options[:per_page] || StreamSend::PER_PAGE_DEFAULT
+        def uri
+          "#{base_uri}.xml"
         end
       end
 
@@ -47,7 +45,7 @@ module StreamSend
         end
 
         def uri
-          "#{blast_uri_for(@blast_id)}#{paging_query_string}"
+          "#{blast_uri_for(@blast_id)}"
         end
       end
     end

data/lib/streamsend/api/blast.rb

@@ -1,21 +1,21 @@
 module StreamSend
   module Api
     module Blast
-      class Index < StreamSend::Api::Call::AudienceIndex
+      class Index < StreamSend::Api::Call::Index
         def uri
-          "#{audiences_uri}#{paging_query_string}"
+          "#{audiences_uri}"
         end
       end
 
-      class Scheduled < StreamSend::Api::Call::AudienceIndex
+      class Scheduled < StreamSend::Api::Call::Index
         def uri
-          "#{base_audience_uri}/scheduled.xml#{paging_query_string}"
+          "#{base_audience_uri}/scheduled.xml"
         end
       end
 
-      class Sent < StreamSend::Api::Call::AudienceIndex
+      class Sent < StreamSend::Api::Call::Index
         def uri
-          "#{base_audience_uri}/sent.xml#{paging_query_string}"
+          "#{base_audience_uri}/sent.xml"
         end
       end
 

data/lib/streamsend/api/bounce.rb

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

data/lib/streamsend/api/click.rb

@@ -9,8 +9,8 @@ module StreamSend
         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}"
+          return "#{base_blast_only_for(@blast_id)}/links/#{@link_id}/clicks.xml" if @link_id
+          "#{base_blast_uri_for(@blast_id)}.xml"
         end
       end
     end

data/lib/streamsend/api/configuration.rb

@@ -21,6 +21,10 @@ module StreamSend
       def self.base_uri
         config["root_account"]["base_uri"] if config
       end
+
+      def self.send_data_as_xml
+        config["root_account"]["send_data_as_xml"] if config
+      end
     end
   end
 end

data/lib/streamsend/api/hash_xml_serializer.rb

@@ -0,0 +1,58 @@
+module StreamSend
+  module Api
+    class HashXmlSerializer
+      def serialize(hash, options = {})
+        xml = serialize_hash(hash, options)
+      end
+
+      private
+
+      def serialize_hash(hash, options)
+        builder = get_builder(options)
+        root_name = get_root_name(hash, options)
+
+        hash.keys.each do |key|
+          value = hash[key]
+          if(value.is_a?(Hash))
+            builder.tag!(root_name) do
+              process_nested_hash(key, value, options)
+            end
+          else
+            build_tag_for(builder, key, value)
+          end
+        end
+
+        builder.target!
+      end
+
+      def build_tag_for(builder, key, value)
+        if value
+          value = value.join(", ") if value.is_a?(Array)
+          builder.tag!(tag_name_for(key), value)
+        else
+          builder.tag!(tag_name_for(key), {:nil => true}, value)
+        end
+      end
+
+      def process_nested_hash(key, value, options)
+        options[:skip_instruct] = true
+        options[:root] = tag_name_for(value.keys[0])
+        serialize_hash(value, options)
+      end
+
+      def get_root_name(hash, options)
+        options[:root] || tag_name_for(hash.keys[0])
+      end
+
+      def get_builder(options)
+        xml = options[:builder] ||= ::Builder::XmlMarkup.new(:indent => 2)
+        xml.instruct! unless options[:skip_instruct]
+        xml
+      end
+
+      def tag_name_for(key)
+        key.to_s.dasherize
+      end
+    end
+  end
+end

data/lib/streamsend/api/list.rb

@@ -9,7 +9,7 @@ module StreamSend
 
         def uri
           return "#{base_audience_only}/people/#{@person_id}/lists.xml" if @person_id
-          audiences_uri
+          super
         end
       end
 

data/lib/streamsend/api/membership.rb

@@ -1,7 +1,7 @@
 module StreamSend
   module Api
     module Membership
-      class Index < StreamSend::Api::Call::AudienceIndex
+      class Index < StreamSend::Api::Call::Index
         def execute(person_id, list_id = nil, options = {})
           @person_id = person_id
           @list_id = list_id
@@ -10,8 +10,21 @@ module StreamSend
 
         def uri
           base = "#{base_audience_only}/people/#{@person_id}/"
-           return "#{base}lists/#{@list_id}/memberships.xml#{paging_query_string}" if @list_id
-          "#{base}memberships.xml#{paging_query_string}"
+          return "#{base}lists/#{@list_id}/memberships.xml" if @list_id
+          "#{base}memberships.xml"
+        end
+      end
+
+      class Count < StreamSend::Api::Call::Count
+        def execute(person_id = nil, list_id = nil)
+          @person_id = person_id
+          @list_id = list_id
+          super()
+        end
+
+        def uri
+         return "#{base_audience_only}/people/#{@person_id}/memberships/count.xml" if @person_id
+          "#{base_audience_only}/lists/#{@list_id}/memberships/count.xml"
         end
       end
 

data/lib/streamsend/api/person.rb

@@ -21,7 +21,7 @@ module StreamSend
 
         def uri
           return "#{base_audience_only}/lists/#{@list_id}/people.xml" if @list_id
-          "#{super}#{paging_query_string}"
+          super
         end
       end
 
@@ -45,10 +45,6 @@ module StreamSend
           index_options.merge!(:query => { :owner_id => owner_id })
           super(index_options)
         end
-
-        def uri
-          "#{super}#{paging_query_string}"
-        end
       end
 
       class Activate < StreamSend::Api::Call::BaseCall
@@ -64,14 +60,14 @@ module StreamSend
       class Click < StreamSend::Api::Click::Index
         def uri
           base = "#{session.base_uri}/blasts/#{@blast_id}"
-          return "#{base_blast_only_for(@blast_id)}/links/#{@link_id}/clicks/people.xml#{paging_query_string}" if @link_id
-          "#{base_blast_only_for(@blast_id)}/clicks/people.xml#{paging_query_string}"
+          return "#{base_blast_only_for(@blast_id)}/links/#{@link_id}/clicks/people.xml" if @link_id
+          "#{base_blast_only_for(@blast_id)}/clicks/people.xml"
         end
       end
 
       class View < StreamSend::Api::Call::BlastIndex
         def uri
-          "#{base_blast_only_for(@blast_id)}/views/people.xml#{paging_query_string}"
+          "#{base_blast_only_for(@blast_id)}/views/people.xml"
         end
       end
 

data/lib/streamsend/api/result.rb

@@ -6,7 +6,38 @@ module StreamSend
       end
 
       def to_hash
-        self.marshal_dump
+        marshal_nested_result_object(self)
+      end
+
+      def attributes
+        result_attributes = self.methods.grep /\w=$/
+        result_attributes.collect {|attribute| attribute.to_s.chomp('=')}
+      end
+
+      def self.create_nested_result_object(object_hash)
+        return case object_hash
+        when Hash
+          object_hash = object_hash.clone
+          object_hash.each do |key, value|
+            object_hash[key] = create_nested_result_object(value)
+          end
+          Result.new(object_hash)
+        when Array
+          object_hash = object_hash.clone
+          object_hash.map! { |i| create_nested_result_object(i) }
+        else
+          object_hash
+        end
+      end
+
+      private
+
+      def marshal_nested_result_object(result)
+        result.attributes.each do |attribute|
+          value = result.send(attribute.to_sym)
+          result.send("#{attribute}=", marshal_nested_result_object(value)) if value.is_a?(StreamSend::Api::Result)
+        end
+        result.marshal_dump
       end
     end
   end

data/lib/streamsend/api/session.rb

@@ -1,10 +1,11 @@
 module StreamSend
   module Api
     class Session
-      def initialize(username = nil, password = nil, base_uri = nil)
+      def initialize(username = nil, password = nil, base_uri = nil, use_xml = nil)
         @base_uri = load_base_uri(base_uri)
         @username = load_username(username)
         @password = load_password(password)
+        @send_data_as_xml = send_data_as_xml?(use_xml)
       end
 
       def load_base_uri base_uri
@@ -28,6 +29,13 @@ module StreamSend
         raise StreamSend::Api::Exception.new("Unable to create session: no API password provided.")
       end
 
+      def send_data_as_xml?(send_as_xml)
+        return send_as_xml if send_as_xml
+        return ENV['STREAMSEND_USE_XML'] if ENV['STREAMSEND_USE_XML']
+        return StreamSend::Api::Configuration.send_data_as_xml
+        false
+      end
+
       def get(uri, options = {})
         options.merge!(self.basic_auth_credentials)
         HTTParty.get(uri, options)
@@ -35,11 +43,13 @@ module StreamSend
 
       def put(uri, options = {})
         options.merge!(self.basic_auth_credentials)
+        convert_request_to_xml(options) if send_data_as_xml
         HTTParty.put(uri, options)
       end
 
       def post(uri, options = {})
         options.merge!(self.basic_auth_credentials)
+        convert_request_to_xml(options) if send_data_as_xml
         HTTMultiParty.post(uri, options)
       end
 
@@ -48,10 +58,19 @@ module StreamSend
         HTTParty.delete(uri, options)
       end
 
+      def convert_request_to_xml(options)
+        options[:headers]["Content-Type"] = "text/xml"
+        options[:body] = StreamSend::Api::HashXmlSerializer.new.serialize(options[:body])
+      end
+
       def base_uri
         @base_uri
       end
 
+      def send_data_as_xml
+        @send_data_as_xml
+      end
+
       def basic_auth_credentials
         { :basic_auth => { :username => @username, :password => @password } }
       end
@@ -59,7 +78,9 @@ module StreamSend
       def audience_id
         @audience_id ||= get_audience_id
       end
+
 private
+
       def get_audience_id
         audience = StreamSend::Api::Audience::Index.new(self).execute().first
         if audience

data/lib/streamsend/api/unsubscribe.rb

@@ -6,13 +6,13 @@ module StreamSend
 
       class Manual < StreamSend::Api::Call::BlastIndex
         def uri
-          "#{base_blast_uri_for(@blast_id)}/manual.xml#{paging_query_string}"
+          "#{base_blast_uri_for(@blast_id)}/manual.xml"
         end
       end
 
       class Complaint < StreamSend::Api::Call::BlastIndex
         def uri
-          "#{base_blast_uri_for(@blast_id)}/complaint.xml#{paging_query_string}"
+          "#{base_blast_uri_for(@blast_id)}/complaint.xml"
         end
       end
     end

data/lib/streamsend/version.rb

@@ -1,3 +1,3 @@
 module StreamSend
-  VERSION = "1.0.0.rc16"
+  VERSION = "1.0.0.rc19"
 end

data/lib/streamsend.rb

@@ -1,6 +1,7 @@
 require "rubygems"
 require "httmultiparty"
 require "ostruct"
+require "builder"
 require "active_support/inflector"
 require "active_support/core_ext"
 
@@ -14,6 +15,7 @@ require "streamsend/api/base/show"
 require "streamsend/api/base/update"
 require "streamsend/api/base/create"
 require "streamsend/api/base/destroy"
+require "streamsend/api/base/count"
 require "streamsend/api/audience"
 require "streamsend/api/session"
 
@@ -37,7 +39,4 @@ require "streamsend/api/unsubscribe"
 require "streamsend/api/upload"
 require "streamsend/api/view"
 require "streamsend/api/user"
-
-module StreamSend
-  PER_PAGE_DEFAULT = 100
-end
+require "streamsend/api/hash_xml_serializer"

data/spec/lib/streamsend/api/integration/blast_spec.rb

@@ -25,7 +25,7 @@ module StreamSend
         describe Index do
           it "returns an index of blasts" do
             index = Index.new(session)
-            blasts = index.execute
+            blasts = index.execute(:page => 1)
             expect(blasts.count).to be > 0
           end
         end
@@ -33,9 +33,9 @@ module StreamSend
         describe Scheduled do
           it "returns scheduled blasts if there are any" do
             scheduler = Scheduled.new(session)
-            scheduled = scheduler.execute
+            scheduled = scheduler.execute(:page => 1)
             if scheduled.count > 0
-              scheduled_values = ["scheduled", "preparing"]
+              scheduled_values = ["scheduled", "preparing", "failed to render", "waiting"]
               expect(scheduled_values).to include(scheduled[0].status)
             else
               pending "No scheduled blasts at this time to inspect or something went wrong."
@@ -46,7 +46,7 @@ module StreamSend
         describe Sent do
           it "returns sent blasts" do
             senter = Sent.new(session)
-            sent = senter.execute
+            sent = senter.execute({:page => 1})
             expect(sent.count).to be > 0
             expect(sent[0].status).to eq("sent")
           end

data/spec/lib/streamsend/api/integration/bounce_spec.rb

@@ -21,16 +21,19 @@ module StreamSend
 
           describe "#execute" do
             it "returns an array of bounces" do
+              pending "Can't create bounces"
               bounces  = indexer.execute(@blast_id)
               expect(bounces.count).to be <= 1
             end
 
             it "returns an array of hard bounces" do
+              pending "Can't create bounces"
               bounces  = harder.execute(@blast_id)
               expect(bounces.count).to eq(0) #can't create a hard bounce :/
             end
 
             it "returns an array of soft bounces" do
+              pending "Can't create bounces"
               bounces  = softer.execute(@blast_id)
               expect(bounces.count).to eq(1)
               expect(bounces[0].bounce_type).to eq("soft")

data/spec/lib/streamsend/api/integration/click_spec.rb

@@ -21,11 +21,13 @@ module StreamSend
 
           describe "#execute" do
             it "returns an array of clicks" do
+              pending "Can't create clicks through api"
               bounces  = indexer.execute(blast_id)
               expect(bounces.count).to be > 0
             end
 
             it "returns an array of clicks by link_id" do
+              pending "Can't create clicks through api"
               bounces  = indexer.execute(blast_id, link_id)
               expect(bounces.count).to be > 0
             end

data/spec/lib/streamsend/api/integration/link_spec.rb

@@ -17,6 +17,7 @@ module StreamSend
 
         describe Index do
           it "returns an array of links" do
+            pending "Create blast, don't expect fixture"
             indexer = Index.new(session)
             links = indexer.execute(blast_id)
             expect(links.count).to be > 0
@@ -25,6 +26,7 @@ module StreamSend
 
         describe Show do
           it "returns a link by id" do
+            pending "Create blast, don't expect fixture"
             indexer = Index.new(session)
             links = indexer.execute(blast_id)
             link = links[0]

data/spec/lib/streamsend/api/integration/membership_spec.rb

@@ -27,7 +27,7 @@ module StreamSend
             id = creator.execute(membership_hash)
 
             indexer = Index.new(session)
-            memberships = indexer.execute(person_id)
+            memberships = indexer.execute(person_id, nil, :page => 1)
             expect(memberships.count).to be > 0
 
             destroyer = Destroy.new(session)
@@ -63,6 +63,32 @@ module StreamSend
             end.to raise_exception(StreamSend::Api::Exception, "Could not find any memberships with the specified id. (404)")
           end
         end
+
+        describe Count do
+          it "returns a count of people one a list" do
+            creator = Create.new(session)
+            id = creator.execute(membership_hash)
+
+            counter = Count.new(session)
+            people_count = counter.execute(person_id)
+            expect(people_count).to eq(1)
+
+            destroyer = Destroy.new(session)
+            destroyer.execute(id)
+          end
+
+          it "returns a count of lists a person is on" do
+            creator = Create.new(session)
+            id = creator.execute(membership_hash)
+
+            counter = Count.new(session)
+            list_count = counter.execute(nil, list_id)
+            expect(list_count).to eq(1)
+
+            destroyer = Destroy.new(session)
+            destroyer.execute(id)
+          end
+        end
       end
     end
   end