zuck 0.0.4

data/lib/zuck/fb_object/write.rb

@@ -0,0 +1,75 @@
+module Zuck
+ module FbObject
+   module Write
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def save
+      self.class.raise_if_read_only
+
+      # Tell facebook to return
+      data = @hash_delegator_hash.merge(redownload: 1)
+      data = data.stringify_keys
+
+      # Don't post ids, because facebook doesn't like it
+      data = data.keep_if{ |k,v| k != "id" }
+
+      # Update on facebook
+      result = post(graph, path, data)
+
+      # The data is nested by name and id, e.g.
+      #
+      #     "campaigns" => { "12345" => "data" }
+      #
+      # Since we only put one at a time, we'll fetch this like that.
+      data = result["data"].values.first.values.first
+
+      # Update and return
+      set_data(data)
+      result["result"]
+    end
+
+    def destroy
+      self.class.destroy(graph, path)
+    end
+
+
+    module ClassMethods
+
+      def raise_if_read_only
+        return unless read_only?
+        raise Zuck::Error::ReadOnly.new("#{self} is read_only")
+      end
+
+      def create(graph, data, parent=nil, path=nil)
+        raise_if_read_only
+        p = path || parent.path
+
+        # We want facebook to return the data of the created object
+        data["redownload"] = 1
+
+        # Create
+        result = create_connection(graph, p, list_path, data)["data"]
+
+        # The data is nested by name and id, e.g.
+        #
+        #     "campaigns" => { "12345" => "data" }
+        #
+        # Since we only put one at a time, we'll fetch this like that.
+        data = result.values.first.values.first
+
+        # Return a new instance
+        new(graph, data, parent)
+      end
+
+      def destroy(graph, id)
+        raise_if_read_only
+        delete(graph, id)
+      end
+
+    end
+
+   end
+ end
+end

data/lib/zuck/fb_object.rb

@@ -0,0 +1,53 @@
+Dir[File.expand_path("../koala/**/*.rb", __FILE__)].each{ |f| require f}
+Dir[File.expand_path("../fb_object/**/*.rb", __FILE__)].each{ |f| require f}
+
+module Zuck
+  module FbObject
+    # An object that includes {Zuck::HashDelegator} for easy hash
+    # access and default keys as methods as well as the `graph`
+    # getter and setter from {Zuck::Koala::Methods}.
+    #
+    # By inheriting from this object, each fb object gets implemented
+    # automatically (tm) through calling a couple of DSL methods and
+    # defining how an object can obtain its own path.
+    #
+    # I feel it is example time, here's an imaginary ad campaign:
+    #
+    #     class AdCampaign < FbObject
+    #
+    #       known_keys    :title, :budget
+    #       parent_object :ad_account
+    #       list_path     :adcampaigns
+    #       connections   :ad_groups
+    #
+    #     end
+    #
+    # These handy things are now provided by {FbObject} to your object:
+    #
+    # 1.  Each `AdCampaign` object has a `title` and `budget` method. In
+    #     case facebook returned more information than what's documented
+    #     (there are a lot of these), you can still call
+    #     `my_campaign[:secret_key]` to get to the juicy bits
+    # 2.  You can call `AdCampaign.all(graph, my_ad_account)`, because your
+    #     `AdCampaign` instance knows how to construct the path
+    #     `act_12345/adcampaigns`. It knows this, because it knows its
+    #     parent object and its own list path.
+    # 3.  You can call `#ad_groups` on any `AdCampaign` instance to fetch 
+    #     the ad groups in that campaign. To add an ad_group to a campaign,
+    #     you can call `AdGroup.create(graph, data, my_campaign)`, or for
+    #     short: `my_campaign.create_ad_group(data)`
+    #
+    class RawFbObject
+      extend  Zuck::FbObject::Helpers
+      include Zuck::FbObject::Helpers
+      include Zuck::HashDelegator
+      include Zuck::KoalaMethods
+      include Zuck::FbObject::DSL
+      include Zuck::FbObject::Read
+      include Zuck::FbObject::Write
+    end
+  end
+end
+
+# See #{Zuck::FbObject::RawFbObject}
+Zuck::RawFbObject = Zuck::FbObject::RawFbObject

data/lib/zuck/koala/koala_methods.rb

@@ -0,0 +1,27 @@
+module Zuck
+  module KoalaMethods
+
+    # You can include this to any object that should have a `graph`
+    # getter and setter that checks for {::Koala::Facebook::API}
+    # instances with an access token.
+
+    def graph=(g)
+      validate_graph(g)
+      @graph = g
+    end
+
+    def graph
+      @graph
+    end
+
+    private
+
+    def validate_graph(g)
+      e = "#{g.class} is not a Koala::Facebook::API"
+      raise e unless g.is_a? ::Koala::Facebook::API
+      e = "#{g} does not work without an access_token"
+      raise e unless g.access_token
+    end
+
+  end
+end

data/lib/zuck.rb

@@ -0,0 +1,9 @@
+require 'active_support/all'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'zuck/koala/koala_methods'
+require 'zuck/fb_object'
+Dir[File.expand_path("../zuck/facebook/**/*.rb", __FILE__)].each{ |f| require f}
+
+module Zuck
+  extend KoalaMethods
+end

data/spec/fixtures/a_single_account.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://graph.facebook.com/act_10150585630710217?access_token=AAAEvJ5vzhl8BABhTSazJZB2D0B4N0l242VX22Hg9J2WZA7fptcAztfXxfAZB9mhZB6W1nl5dz5tXMlb9DJk9ibs6RqtP7PtO6a3XCiHWVwZDZD
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "QWNjZXNzLUNvbnRyb2wtQWxsb3ctT3JpZ2lu":
+      - !binary |-
+        Kg==
+      !binary "Q2FjaGUtQ29udHJvbA==":
+      - !binary |-
+        cHJpdmF0ZSwgbm8tY2FjaGUsIG5vLXN0b3JlLCBtdXN0LXJldmFsaWRhdGU=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC9qYXZhc2NyaXB0OyBjaGFyc2V0PVVURi04
+      !binary "RXRhZw==":
+      - !binary |-
+        Ijc1NWUyMTBmYjE2N2NkOTQxNWI3ODIzZTZjOGM4YjYwYTQ1MzUwZTUi
+      !binary "RXhwaXJlcw==":
+      - !binary |-
+        U2F0LCAwMSBKYW4gMjAwMCAwMDowMDowMCBHTVQ=
+      !binary "UHJhZ21h":
+      - !binary |-
+        bm8tY2FjaGU=
+      !binary "WC1GYi1SZXY=":
+      - !binary |-
+        NjEyNTY1
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+      !binary "WC1GYi1EZWJ1Zw==":
+      - !binary |-
+        L3l3UTJxVWc2L0toZVhhTnFXY21lVFFsSW0vVkFEV09tUFIvQVkzVWsxTT0=
+      !binary "RGF0ZQ==":
+      - !binary |-
+        VHVlLCAyMSBBdWcgMjAxMiAxNDo1MjoyNCBHTVQ=
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        a2VlcC1hbGl2ZQ==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        NTA1
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6VSTWvcMBD9K0anFgSV7LU361tDQqHQU8mlTRGyLO8OsSWj
+        j8Bm2f/e0W7i2MS3nOz39GbmzceJQEtqIlUQnPGSlTdlVbAtZznfEoq8stEE
+        cRGtCYwcND7NpD7IED2pOSUqOqeNOqLg4fcdagIM+sUafcm32c6I1zz30dlR
+        P3671a4HM4+wXed1EAcbnRcxKFLnlIAXo3beGtmTmlHSRA9Gey9e093CPvsF
+        Tzr73jvYH0L28CP7cpBdiGbvG+3VwT1GxvTGPIWvWG2K98FpHdD3JzPkmOLn
+        tcReO9Na12mX/dHQ66zi84oKQprT1PjMigxpxB9fXmBMW8lztltkShtzR6Fs
+        m+Lu7vHxWQbxtpiCklZCfxR+1KYVPQyAneYlYzjB6HGepP57IjHtqGR8W+At
+        VJTgoAfwHqxJ75zmtKAbWtLtP0qc7bEUZ4yfERkboAMlA2oFLi0ATpvUJzJl
+        SwDV7PLFwDNNEP/mEGd3hZTgb8WuomKV3SxDyyWslnC3gHzpgs9d5DOP7y6Q
+        nUQL9uL4zSuqVrwiO3ldxE6W39litTqyK9WRXVRHvFI97XjWfPUBzpvfrZa/
+        WWHPuBolR9lADwF0uo8c76CRvTQKDwPvarBWtLqTsQ94mOYZryxdR5OOLF3C
+        +T90T7SjiQQAAA==
+    http_version: 
+  recorded_at: Tue, 21 Aug 2012 14:52:25 GMT
+recorded_with: VCR 2.2.4

data/spec/fixtures/a_single_campaign.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://graph.facebook.com/6005950787751?access_token=AAAEvJ5vzhl8BABhTSazJZB2D0B4N0l242VX22Hg9J2WZA7fptcAztfXxfAZB9mhZB6W1nl5dz5tXMlb9DJk9ibs6RqtP7PtO6a3XCiHWVwZDZD
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Etag:
+      - ! '"050868a2c006f558b70017a737ca8f72419e7bc1"'
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Pragma:
+      - no-cache
+      X-Fb-Rev:
+      - '612565'
+      X-Fb-Debug:
+      - o5ZT1cHA5d8AdQpUe+7pBF0kc5dqhirTcSEjdEaM7m8=
+      Date:
+      - Tue, 21 Aug 2012 14:13:01 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '294'
+    body:
+      encoding: US-ASCII
+      string: ! '{"account_id":"10150585630710217","campaign_id":6005950787751,"name":"bloody","daily_budget":1000,"campaign_status":1,"daily_imps":0,"id":"6005950787751","start_time":"2012-08-21T14:04:13+0000","end_time":null,"updated_time":"2012-08-21T14:08:34+0000","created_time":"2012-08-21T14:04:13+0000"}'
+    http_version: 
+  recorded_at: Tue, 21 Aug 2012 14:13:02 GMT
+recorded_with: VCR 2.2.4

data/spec/fixtures/create_ad_campaign.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://graph.facebook.com/act_10150585630710217/adcampaigns
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        ZGFpbHlfYnVkZ2V0PTEwMDAmbmFtZT1ibG9vZHkmcmVkb3dubG9hZD0xJmFj
+        Y2Vzc190b2tlbj1BQUFFdko1dnpobDhCQUJoVFNhekpaQjJEMEI0TjBsMjQy
+        VlgyMkhnOUoyV1pBN2ZwdGNBenRmWHhmQVpCOW1oWkI2VzFubDVkejV0WE1s
+        YjlESms5aWJzNlJxdFA3UHRPNmEzWENpSFdWd1pEWkQ=
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Pragma:
+      - no-cache
+      X-Fb-Rev:
+      - '613755'
+      X-Fb-Debug:
+      - VWQPQsWPxgIjh4Npecy0FD6424cPN2uUCWXr8RfiIVQ=
+      Date:
+      - Tue, 21 Aug 2012 14:04:16 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '308'
+    body:
+      encoding: US-ASCII
+      string: ! '{"id":"6005950787751","data":{"campaigns":{"6005950787751":{"account_id":"10150585630710217","campaign_id":6005950787751,"name":"bloody","daily_budget":1000,"campaign_status":1,"daily_imps":0,"id":"6005950787751","start_time":1345557853,"end_time":null,"updated_time":1345557855,"created_time":1345557853}}}}'
+    http_version: 
+  recorded_at: Tue, 21 Aug 2012 14:04:16 GMT

data/spec/fixtures/create_ad_group.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://graph.facebook.com/act_10150585630710217/adgroups
+    body:
+      encoding: US-ASCII
+      string: bid_type=1&max_bid=1&name=Rap+like+me&targeting=%7B%22countries%22%3A%5B%22US%22%5D%7D&creative=%7B%22type%22%3A25%2C%22action_spec%22%3A%7B%22action.type%22%3A%22like%22%2C+%22post%22%3A10150420410887685%7D%7D&campaign_id=6005950787751&redownload=1&access_token=AAAEvJ5vzhl8BABhTSazJZB2D0B4N0l242VX22Hg9J2WZA7fptcAztfXxfAZB9mhZB6W1nl5dz5tXMlb9DJk9ibs6RqtP7PtO6a3XCiHWVwZDZD
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Pragma:
+      - no-cache
+      X-Fb-Rev:
+      - '612565'
+      X-Fb-Debug:
+      - dMRAOMEruKynwNICdc9U+JFPheRyF5jVa8rHgupYgWI=
+      Date:
+      - Tue, 21 Aug 2012 14:05:56 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '1195'
+    body:
+      encoding: US-ASCII
+      string: ! '{"id":"6005950791151","data":{"adgroups":{"6005950791151":{"adgroup_id":6005950791151,"ad_id":6005950791151,"campaign_id":6005950787751,"name":"Rap
+        like me","adgroup_status":4,"bid_type":1,"max_bid":"1","bid_info":{"1":"1"},"ad_status":4,"locations":[3],"impression_control_map":[{"location":3,"control":{"impression_control_type":2,"user_impression_limit":3,"user_impression_limit_period":24,"user_impression_limit_period_unit":0}}],"account_id":"10150585630710217","id":"6005950791151","creative_ids":[6005851371551],"targeting":{"countries":["US"],"friends_of_connections":[{"id":"6005851366351","name":null}]},"conversion_specs":[{"action.type":"like","post":"10150420410887685"}],"last_updated_by_app_id":333322143368799,"start_time":null,"end_time":null,"updated_time":1345557956,"created_time":1345557955}},"creatives":{"6005851371551":{"type":25,"action_spec":{"action.type":"like","post":"10150420410887685"},"related_fan_page":1,"cluster_id":6005851366351,"name":"Sponsored
+        story #6005851371551","run_status":1,"preview_url":"http:\/\/www.facebook.com\/ads\/api\/creative_preview.php?cid=6005851371551","count_current_adgroups":11,"id":"6005851371551","creative_id":"6005851371551"}}}}'
+    http_version:
+  recorded_at: Tue, 21 Aug 2012 14:05:56 GMT

data/spec/fixtures/delete_ad_group.yml

@@ -0,0 +1,50 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://graph.facebook.com/6004497038951
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        YWNjZXNzX3Rva2VuPUFBQUV2SjV2emhsOEJBQmhUU2F6SlpCMkQwQjROMGwy
+        NDJWWDIySGc5SjJXWkE3ZnB0Y0F6dGZYeGZBWkI5bWhaQjZXMW5sNWR6NXRY
+        TWxiOURKazlpYnM2UnF0UDdQdE82YTNYQ2lIV1Z3WkRaRCZtZXRob2Q9ZGVs
+        ZXRl
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Content-Type:
+      - text/javascript; charset=UTF-8
+      Expires:
+      - Sat, 01 Jan 2000 00:00:00 GMT
+      Pragma:
+      - no-cache
+      X-Fb-Rev:
+      - '612565'
+      X-Fb-Debug:
+      - avl/vpqMd+xVIPXir1VXIWHjUEpg4VLpSSFim8G0OJk=
+      Date:
+      - Tue, 21 Aug 2012 14:11:08 GMT
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '4'
+    body:
+      encoding: US-ASCII
+      string: 'true'
+    http_version: 
+  recorded_at: Tue, 21 Aug 2012 14:11:08 GMT
+recorded_with: VCR 2.2.4