adcloud 0.7.1 → 0.7.2

data/RELEASE_NOTES.md

@@ -1,6 +1,12 @@
 Release Notes
 =============
 
+### 0.7.2
+
+* Add campaign and advertisement attributes
+* Allow campaign state changes
+* Allow advertisement deletion (including media files)
+
 ### 0.7.1
 
 * Remove Gemfile.lock from gem

data/lib/adcloud/advertisement.rb

@@ -2,6 +2,7 @@ module Adcloud
   class Advertisement < Adcloud::Entity
     attribute :id, Integer
     attribute :product_id, Integer
+    attribute :campaign_id, Integer
     attribute :type, String
     attribute :advertisement_design_id, Integer
     attribute :target_url, String

data/lib/adcloud/campaign.rb

@@ -37,18 +37,21 @@ module Adcloud
     attribute :keyword_lifetime, Integer
     attribute :comment, String
     attribute :budget_limit, Float
+    attribute :budget_limit_today, Float
     attribute :budget_limit_allowed, Boolean
     attribute :unit_price_maximum, Float
     attribute :locations, Array
     attribute :type, Integer
+    attribute :topic_ids, Array
     attribute :delivery_external, Boolean
     attribute :delivery_internal, Boolean
     attribute :delivery_type, Integer
     attribute :deactivated_on, DateTime
+    attribute :options, Hash
+    attribute :has_end_date, Boolean
     attribute :modified, DateTime
     attribute :created, DateTime
     # attribute :fixed_price, # missing
-    # attribute :mobile_targeting, # missing
 
     # @return [void] Validate the campaign against the api
     def validate
@@ -60,6 +63,16 @@ module Adcloud
       end
     end
 
+    def request_approval!
+      result = connection.put("campaigns/#{self.id}/request_approval")
+      result && result["_meta"] && result["_meta"]["status"] == 200 || false
+    end
+
+    def end!
+      result = connection.put("campaigns/#{self.id}/end")
+      result && result["_meta"] && result["_meta"]["status"] == 200 || false
+    end
+
     # @return [Boolean] True when campaign is valid - otherwise false
     def valid?
       self.validate

data/lib/adcloud/campaign_state.rb

@@ -0,0 +1,25 @@
+class CampaignState
+  STATES = {
+    :inactive => 0,
+    :online => 1,
+    :offer => 2,
+    :rejected => 3,
+    :accepted => 4,
+    :awaiting_approval => 5,
+    :paused => 6,
+    :ended => 7,
+    :billed => 9,
+    :paid => 10,
+    :approved => 11,
+    :canceled => 12,
+    :approval_rejected => 13,
+  }
+
+  def id_to_string(id)
+    STATES.find { |_, value| value.to_s == id.to_s }
+  end
+
+  def string_to_id(string)
+    STATES[string.to_sym]
+  end
+end

data/lib/adcloud/connection.rb

@@ -42,5 +42,15 @@ module Adcloud
       response.body
     end
 
+    def put(path, params = {})
+      response = connection.put path, params
+      response.body
+    end
+
+    def delete(path, params = {})
+      response = connection.delete path, params
+      response.body
+    end
+
   end
 end

data/lib/adcloud/entity.rb

@@ -3,6 +3,8 @@ module Adcloud
   class Entity
     include Virtus
 
+    MAX_PER_PAGE = 200
+
     attr_accessor :errors
 
     attribute :_meta, Hash
@@ -27,6 +29,11 @@ module Adcloud
       false
     end
 
+    def destroy
+      result = connection.delete("#{self.class.api_endpoint}/#{id}")
+      self
+    end
+
     class << self
       attr_accessor :api_endpoint, :connection
 
@@ -45,9 +52,22 @@ module Adcloud
       # @return [Array] Entities matching the criteria or all
       def all(filter = {}, page = 1, per_page = 50)
         result = connection.get(self.api_endpoint, :filter => filter, :page => page, :per_page => per_page)
+        yield result['_meta'] if block_given?
         result["items"].map { |raw_campaign| self.new(raw_campaign) }
       end
 
+      # fetches all objects via pagination. Be careful, this could be a lot!
+      def all!(filter = {})
+        result = []
+        page = 0
+        total_pages = 1
+        begin
+          page += 1
+          result += self.all(filter, page, MAX_PER_PAGE) { |meta_data| total_pages = meta_data['total_pages'] }
+        end while page < total_pages
+        result
+      end
+
       # @return [Object] The entity with the unique identifier
       def find(id)
         result = connection.get("#{self.api_endpoint}/#{id}")

data/lib/adcloud/version.rb

@@ -1,3 +1,3 @@
 module Adcloud
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/test/adcloud/campaign_test.rb

@@ -51,4 +51,36 @@ describe Adcloud::Campaign do
     end
   end
 
+  describe '#request_approval!' do
+    before { campaign.id = 123 }
+
+    it 'is true when the state has changed' do
+      response_data = {'_meta' => { 'status' => 200, 'message' => 'status changed' } }
+      connection.expects(:put).with('campaigns/123/request_approval').returns(response_data)
+      campaign.request_approval!.must_equal true
+    end
+
+    it 'is false when the state could not be changed' do
+      response_data = {'_meta' => { 'status' => 400, 'message' => 'bad request' } }
+      connection.expects(:put).with('campaigns/123/request_approval').returns(response_data)
+      campaign.request_approval!.must_equal false
+    end
+  end
+
+  describe '#end!' do
+    before { campaign.id = 123 }
+
+    it 'is true when the state has changed' do
+      response_data = {'_meta' => { 'status' => 200, 'message' => 'status changed' } }
+      connection.expects(:put).with('campaigns/123/end').returns(response_data)
+      campaign.end!.must_equal true
+    end
+
+    it 'is false when the state could not be changed' do
+      response_data = {'_meta' => { 'status' => 400, 'message' => 'bad request' } }
+      connection.expects(:put).with('campaigns/123/end').returns(response_data)
+      campaign.end!.must_equal false
+    end
+  end
+
 end

data/test/adcloud/connection_test.rb

@@ -7,20 +7,16 @@ describe Adcloud::Connection do
   let(:authentication) { stub(:authenticate! => true, :token => "0987654321") }
 
   describe "url" do
-  
     it "should be https://api.adcloud.com:443/" do
       subject.url.must_equal "https://api.adcloud.com:443/v2/"
     end
-  
   end
 
   describe "authentication token" do
-  
     it "should be 0987654321" do
       subject.expects(:authentication).returns(authentication)
       subject.authentication_token.must_equal "0987654321"
     end
-  
   end
 
   describe "authentication" do
@@ -36,43 +32,33 @@ describe Adcloud::Connection do
     before do
       subject.stubs(:authentication_token).returns("0987654321")
     end
-    
-    describe "post" do
 
+    describe "post" do
       it "should fire a post request" do
         stub_request(:post, url).to_return(:status => 200, :body => {"_meta" => {}, "hello" => "world"}, :headers => {})
         subject.post('whatever').must_equal({"_meta" => {}, "hello" => "world" })
       end
+    end
 
-      # it "should raise an InvalidRequest Exception" do
-      #   stub_request(:post, url).to_return(:status => 500, :body => "{}", :headers => {})
-      #   -> { subject.post('whatever') }.must_raise(Adcloud::InvalidRequest)
-      # end
+    describe "put" do
+      it "should fire a put request" do
+        stub_request(:put, url).to_return(:status => 200, :body => { "_meta" => {}, "hello" => "world" }, :headers => {})
+        subject.put('whatever').must_equal({ "_meta" => {}, "hello" => "world" })
+      end
+    end
 
+    describe "delete" do
+      it "should fire a delete request" do
+        stub_request(:delete, url).to_return(:status => 200, :body => { "_meta" => {}, "hello" => "world" }, :headers => {})
+        subject.delete('whatever').must_equal({ "_meta" => {}, "hello" => "world" })
+      end
     end
 
     describe "get" do
-
       it "should fire a get request" do
         stub_request(:get, url).to_return(:status => 200, :body => {"_meta" => {}, "hello" => "world"}, :headers => {})
         subject.get('whatever').must_equal({"_meta" => {}, "hello" => "world" })
       end
-
-      # it "should raise an InvalidFilter Exception" do
-      #   stub_request(:get, url).to_return(:status => 400, :body => "{}", :headers => {})
-      #   -> { subject.get('whatever') }.must_raise(Adcloud::InvalidFilter)
-      # end
-
-      # it "should raise a NotFound Exception" do
-      #   stub_request(:get, url).to_return(:status => 404, :body => "{}", :headers => {})
-      #   -> { subject.get('whatever') }.must_raise(Adcloud::NotFound)
-      # end
-
-      # it "should raise an InvalidRequest Exception" do
-      #   stub_request(:get, url).to_return(:status => 500, :body => "{}", :headers => {})
-      #   -> { subject.get('whatever') }.must_raise(Adcloud::InvalidRequest)
-      # end
-
     end
   end
 end

data/test/adcloud/entity_test.rb

@@ -73,6 +73,20 @@ describe Adcloud::Entity do
     end
   end
 
+  describe '.all!' do
+    let(:items) { (1..200).to_a.map{ |i| { "id" => i, "name" => "Test Car #{i}", "_meta" => { "type" => "Car" } } } }
+    let(:first_page) { { "_meta" => { "type" => "Array<Car>", "page" => 1, "size" => 200, "per_page" => 200, "total_count" => 201, "total_pages" => 2, "sort" => {}, "uuid" => "aabe4f5f31691f049ea1942e6a6d1793" }, "items" => items} }
+    let(:second_page) { { "_meta" => { "type" => "Array<Car>", "page" => 2, "size" => 1, "per_page" => 200, "total_count" => 201, "total_pages" => 2, "sort" => {}, "uuid" => "aabe4f5f31691f049ea1942e6a6d1794" }, "items" => [{ "id" => 201, "name" => "Test Car 201", "_meta" => { "type" => "Car" } }]} }
+
+    before { subject.stubs(:connection => connection) }
+
+    it 'fetches all entity objects' do
+      connection.expects(:get).with('cars', :filter => {}, :page => 1, :per_page => 200).returns(first_page)
+      connection.expects(:get).with('cars', :filter => {}, :page => 2, :per_page => 200).returns(second_page)
+      subject.all!.size.must_equal 201
+    end
+  end
+
   describe '#create' do
     before { subject.stubs(:connection => connection) }
 
@@ -129,6 +143,14 @@ describe Adcloud::Entity do
     end
   end
 
+  describe '.delete' do
+    it 'deletes an existing car' do
+      car = subject.new(:id => 42)
+      car.connection.expects(:delete).returns('response')
+      car.destroy.must_equal car
+    end
+  end
+
   describe "errors" do
     it "should be empty" do
       subject.new.errors.must_be_empty

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adcloud
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -179,6 +179,7 @@ files:
 - lib/adcloud/api_error.rb
 - lib/adcloud/authentication.rb
 - lib/adcloud/campaign.rb
+- lib/adcloud/campaign_state.rb
 - lib/adcloud/connection.rb
 - lib/adcloud/customer.rb
 - lib/adcloud/entity.rb