broadstreet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ed338038c8319c4491ee57dbe1cdca6c65b8f3c
+  data.tar.gz: 24def22fd30cfa36ecbba67f39b7b79497e3e3e1
+SHA512:
+  metadata.gz: d07b75367caff967dcc4f8a9331b458c1594bf8b4d46e4640c44665c383074105c84511c4b7de4d9c2bab05a925094e580c1941983a47127af673ac6491cd42f
+  data.tar.gz: 88062d795602117df6fe9f5a0a613dbfc1402d9304f800e350764ae9976d6e1928e011d82a97d2f598662291f48bced56ab384b8a0f5d2051602e4a3019743ad

data/lib/broadstreet/advertiser_methods.rb

@@ -0,0 +1,52 @@
+module Broadstreet
+
+  module AdvertiserMethods
+
+    # Create a new advertiser
+    #
+    # @param [Fixnum] network_id: The ID of the network for the new advertiser
+    # @param [Hash] params: The detail to create the network with
+    # @option params [String] name: The name for the advertiser
+    # @return [Hash] the detail of the new advertiser
+    def create_advertiser(network_id, params)
+      request(:post, "api/1/networks/#{network_id}/advertisers", params).advertiser
+    end
+
+    # Update the detail of a given advertiser
+    #
+    # @param [Fixnum] advertiser_id: The ID of the advertiser to update
+    # @param [Hash] params: The detail to update the network with
+    # @option params [String] name: The name for the advertiser
+    # @return [Hash] the detail of the updated advertiser
+    def update_advertiser(advertiser_id, params)
+      request(:put, "api/1/advertisers/#{advertiser_id}", params).advertiser
+    end
+
+    # Delete an advertiser
+    #
+    # @param [Fixnum] advertiser_id: the ID of the advertiser to delete
+    # @return nil
+    def delete_advertiser(advertiser_id)
+      request :delete, "api/1/advertisers/#{advertiser_id}"
+      nil
+    end
+
+    # Get the detail for a given advertiser
+    #
+    # @param [Fixnum] advertiser_id: The ID of the advertiser to lookup
+    # @return [Hash] the detail hash for the advertiser
+    def get_advertiser(advertiser_id)
+      request(:get, "api/1/advertisers/#{advertiser_id}").advertiser
+    end
+
+    # List advertisers for a given network
+    #
+    # @param [Fixnum] network_id: The ID of the network to retrieve advertisers for
+    # @return [Array<Hash>] an array of detail hashes for the advertisers
+    def list_advertisers(network_id)
+      request(:get, "api/1/advertisers", network_id: network_id).advertisers
+    end
+
+  end
+
+end

data/lib/broadstreet/campaign_methods.rb

@@ -0,0 +1,52 @@
+module Broadstreet
+
+  module CampaignMethods
+
+    # List campaigns for a given advertiser
+    #
+    # @param [Fixnum] advertiser_id: The ID of the advertiser to retrieve campaigns for
+    # @return [Array<Hash>] details of the campaigns for the advertiser
+    def list_campaigns(advertiser_id)
+      request(:get, "api/1/advertiers/#{advertiser_id}/campaigns").campaigns
+    end
+
+    # Get the data for a given campaign
+    #
+    # @param [Fixnum] campaign_id: The ID of the campaign to retrieve
+    # @return [Hash] the detail for the given campaign
+    def get_campaign(campaign_id)
+      request(:get, "api/1/campaigns/#{campaign_id}").campaign
+    end
+
+    # Delete a given campaign
+    #
+    # @param [Fixnum] campaign_id: The ID of the campaign to delete
+    # @return nil
+    def delete_campaign(campaign_id)
+      request :delete, "api/1/campaigns/#{campaign_id}"
+      nil
+    end
+
+    # Update a campaign
+    #
+    # @param [Fixnum] campaign_id: The ID of the campaign to update
+    # @param [Hash] params: The data to update the campaign with
+    # @option params [String] name: The name of the campaign
+    # @return [Hash] the detail of the updated campaign
+    def update_campaign(campaign_id, params)
+      request(:put, "api/1/campaigns/#{camapign_id}", params).campaign
+    end
+
+    # Create a campaign
+    #
+    # @param [Fixnum] advertiser_id: The ID of the advertiser to create the campaign under
+    # @param [Hash] params: The data to create the campaign with
+    # @option params [String] name: The name of the campaign
+    # @return [Hash] the detail of the new campaign
+    def create_campaign(advertiser_id, params)
+      request(:post, "api/1/advertisers/#{advertiser_id}/campaigns", params).campaign
+    end
+
+  end
+
+end

data/lib/broadstreet/client.rb

@@ -0,0 +1,41 @@
+require 'broadstreet/advertiser_methods'
+require 'broadstreet/campaign_methods'
+require 'broadstreet/network_methods'
+require 'broadstreet/user_methods'
+require 'broadstreet/zone_methods'
+require 'hashie'
+require 'faraday'
+require 'json'
+
+module Broadstreet
+
+  class Client
+
+    include AdvertiserMethods
+    include CampaignMethods
+    include NetworkMethods
+    include UserMethods
+    include ZoneMethods
+
+    # Instantiate a new client
+    #
+    # @param [String] access_token: Broadstreet Access Token (optional)
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    private
+
+    def request(method, path, params = {})
+      params[:access_token] = @access_token
+      response = connection.send method, path, params
+      Hashie::Mash.new JSON.parse response.body
+    end
+
+    def connection
+      @connection ||= Faraday.new(:url => 'https://api.broadstreetads.com')
+    end
+
+  end
+
+end

data/lib/broadstreet/network_methods.rb

@@ -0,0 +1,40 @@
+module Broadstreet
+
+  module NetworkMethods
+
+    # List accessible networks
+    #
+    # @return [Array<Hash>] the data for the networks
+    def list_networks
+      request(:get, 'api/1/networks').networks
+    end
+
+    # Get a particular network
+    #
+    # @param [Fixnum] network_id: The ID of the network to retrieve
+    # @return [Hash] the network detail
+    def get_network(network_id)
+      request(:get, "api/1/networks/#{network_id}").network
+    end
+
+    # Update the data for a particular network
+    #
+    # @param [Fixnum] network_id: The ID of the network to update
+    # @option params [String] :name The name of the network
+    # @return [Hash] the updated network detail
+    def update_network(network_id, params)
+      request(:put, "api/1/networks/#{network_id}", params).network
+    end
+
+    # Create a new network and make the current user a network_admin
+    #
+    # @param [Hash] params: a hash of the data for the network
+    # @option params [String] :name The name of the network
+    # @return [Hash] the detail of the created network
+    def create_network(params)
+      request(:post, 'api/1/networks', params).network
+    end
+
+  end
+
+end

data/lib/broadstreet/user_methods.rb

@@ -0,0 +1,28 @@
+module Broadstreet
+
+  module UserMethods
+
+    # Create a new broadstreet user
+    #
+    # @param [Hash] params: Detail for the user
+    # @option params [String] name: A name for the user (optional)
+    # @option params [String] email: An email address
+    # @option params [String] password: A password
+    # @return [Hash] user detail
+    def create_user(params)
+      request(:post, 'api/0/users', params).user
+    end
+
+    # Add an email address to the broadstreet newsletter
+    #
+    # param [Hash] params: Detail for the email address
+    # @option params [String] email: The email address to add
+    # @return nil
+    def create_newsletter_subscription(params)
+      request(:post, 'api/0/newsletter', params)
+      nil
+    end
+
+  end
+
+end

data/lib/broadstreet/version.rb

@@ -0,0 +1,5 @@
+module Broadstreet
+
+  VERSION = '0.0.1'
+
+end

data/lib/broadstreet/zone_methods.rb

@@ -0,0 +1,56 @@
+module Broadstreet
+
+  module ZoneMethods
+
+    # Create a new zone
+    #
+    # @param [Fixnum] network_id: the id of the network to create the zone on
+    # @param [Hash] params: a hash of the data for the zone
+    # @option params [String] :name The name of the zone
+    # @option params [Boolean] :self_server Whether the zone is self serve
+    # @option params [String] :pricing_callback_url Callback for pricing on self-serve zones
+    # @return [Hash] the zone detail
+    def create_zone(network_id, params)
+      request(:post, "api/1/networks/#{network_id}/zones", params).zone
+    end
+
+    # Get a zone
+    #
+    # @param [Fixnum] zone_id: The ID of the zone to retrieve
+    # @return [Hash] the zone detail
+    def get_zone(zone_id)
+      request(:get, "api/1/zones/#{zone_id}").zone
+    end
+
+    # Delete a zone
+    #
+    # @param [Fixnum] zone_id: THe ID of the zone to delete
+    # @return nil
+    def delete_zone(zone_id)
+      request :delete, "api/1/zones/#{zone_id}"
+      nil
+    end
+
+    # List zones for a given network
+    #
+    # @param [Fixnum] network_id: The ID of the network to retrieve zones for
+    # @return [Array<Hash>] the data for the zones on the specified network
+    def list_zones(network_id)
+      request(:get, 'api/1/zones', network_id: network_id).zones
+    end
+
+    # Update a zone
+    #
+    # @param [Fixnum] zone_id: The ID of the zone to update
+    # @param [Hash] params: a hash of the data for the zone
+    # @option params [String] :name The name of the zone
+    # @option params [Boolean] :self_server Whether the zone is self serve
+    # @option params [String] :pricing_callback_url Callback for pricing on self-serve zones
+    # @return [Hash] the updated zone detail
+    def update_zone(zone_id, params)
+      request(:put, "api/1/zones/#{id}", params).zone
+    end
+
+  end
+
+end

data/lib/broadstreet.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+module Broadstreet
+
+  autoload :Client, 'broadstreet/client'
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: broadstreet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Crepezzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: john@broadstreetads.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/broadstreet.rb
+- lib/broadstreet/advertiser_methods.rb
+- lib/broadstreet/campaign_methods.rb
+- lib/broadstreet/client.rb
+- lib/broadstreet/network_methods.rb
+- lib/broadstreet/user_methods.rb
+- lib/broadstreet/version.rb
+- lib/broadstreet/zone_methods.rb
+homepage: https://github.com/broadstreetads/broadstreet-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Broadstreet API Wrapper
+test_files: []