RubyGems - code_broker - Versions diffs - 0.0.1 - Mend

code_broker 0.0.1

Files changed (10) hide show

data/.gitignore +4 -0
data/Gemfile +4 -0
data/REAME.md +41 -0
data/Rakefile +1 -0
data/code_broker.gemspec +26 -0
data/lib/code_broker.rb +89 -0
data/lib/code_broker/config.rb +15 -0
data/lib/code_broker/connection.rb +11 -0
data/lib/code_broker/version.rb +3 -0
metadata +89 -0

data/.gitignore ADDED

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+# Specify your gem's dependencies in code_broker.gemspec
+gemspec

data/REAME.md ADDED

@@ -0,0 +1,41 @@
+# Code Broker Ruby Client
+This is a gem for interacting with [Code Broker](http://codebroker.com)'s API
+## Example Usage
+Put this in some initialization code. In rails for instance:
+`config/initializers/codebroker.rb`.
+``` ruby
+CodeBroker.configure do |c|
+  c.account_id = "<account id>"
+  c.access_key = "<access key>"
+  c.program    = "<program>"
+  c.short_code = "<short code>"
+end
+```
+In a background job (this example is compatible with Resque):
+``` ruby
+class CodeBrokerOptinWorker
+  @queue = :critical
+  def self.perform(number, hour, timezone, program=nil)
+    # logger.info("Opting in #{number} to program '#{program}'")
+    response = CodeBroker.optin(number,
+      :hour     => hour,
+      :timezone => timezone,
+      :program  => program
+    )
+    # logger.info("Response: #{response.body}")
+    if response.body[/<body>(\d{3})/, 1].to_i != 200
+      raise "Bad Response for number #{number}, hour #{hour}, timezone #{timezone}: #{response.body}"
+    end
+  end
+end
+```

data/Rakefile ADDED

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/code_broker.gemspec ADDED

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "code_broker/version"
+Gem::Specification.new do |s|
+  s.name        = "code_broker"
+  s.version     = CodeBroker::VERSION
+  s.authors     = ["Ben Marini"]
+  s.email       = ["ben.marini@akqa.com"]
+  s.homepage    = ""
+  s.summary     = %q{Client library to interface with Code Broker}
+  s.description = %q{Client library to interface with Code Broker}
+  s.rubyforge_project = "code_broker"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_dependency "httparty", "~> 0.8.0"
+end

data/lib/code_broker.rb ADDED

@@ -0,0 +1,89 @@
+require 'httparty'
+class CodeBroker
+  autoload :Connection, "code_broker/connection"
+  autoload :Config,     "code_broker/config"
+  # Optin a phone number to a program.
+  #
+  # number - Phone number to opt-in.
+  # opts   - The Hash options used to refine the selection (default: {}):
+  #          :hour       - Hour of the day the user wants to recieve the message.
+  #                        in 24 hour time.
+  #          :timezone   - Timezone the user wants to recieve the message.
+  #          :day        - Day of the week the user wants to recieve the message,
+  #                        Sunday-Saturday is 1-7.
+  #          :program    - Program to opt-in to. (Defaults to global config)
+  #          :short_code - Short code to opt-in with. (Defaults to global config)
+  #
+  # Usage: CodeBroker.optin("14155551212", :hour => "14", :timezone => "EST", :day => 1)
+  def self.optin(number, opts)
+    Connection.get("/scoptin.jsp",
+      :query => {
+        :spn       => number,
+        :upref     => "yes",
+        :uprefhod  => opts[:hour],
+        :uprefustz => opts[:timezone],
+        :uprefdow  => opts[:day],
+        :program   => ( opts[:program] || Config.program ),
+        :msc       => ( opts[:short_code] || Config.short_code )
+      }
+    )
+  end
+  # Send a real time message.
+  #
+  # number - Phone number to send message to.
+  # opts   - The Hash options used to refine the selection (default: {}):
+  #          :program    - Program. (Defaults to global config)
+  #          :short_code - Short code. (Defaults to global config)
+  #
+  # Usage: CodeBroker.rtm("14155551212", :program => 'PROGRAM')
+  def self.rtm(number, opts) # rtm = real time message
+    raise 'Missing key/value in options: :program. Program is required.' unless opts[:program]
+    Connection.get("/sckwd.jsp",
+      :query => {
+        :spn       => number,
+        :program   => opts[:program],
+        :msc       => ( opts[:short_code] || Config.short_code )
+      }
+    )
+  end
+  # Opt out of a program.
+  #
+  # number - Phone number to opt out.
+  # opts   - The Hash options used to refine the selection (default: {}):
+  #          :program    - Program. (Defaults to global config)
+  #          :short_code - Short code. (Defaults to global config)
+  #
+  # Usage: CodeBroker.optout("14155551212", :program => 'PROGRAM')
+  def self.optout(number)
+    Connection.get("/scoptout.jsp",
+      :query => {
+        :spn     => number,
+        :program => Config.program,
+        :msc     => Config.short_code
+      }
+    )
+  end
+  # Set global configurations for all requests
+  #
+  # Usage:
+  #
+  #   CodeBroker.configure do |c|
+  #     c.account_id = "<account id>"
+  #     c.access_key = "<access key>"
+  #     c.program    = "<program>"
+  #     c.short_code = "<short code>"
+  #   end
+  #
+  def self.configure
+    yield Config if block_given?
+  end
+end

data/lib/code_broker/config.rb ADDED

@@ -0,0 +1,15 @@
+class CodeBroker
+  class Config
+    class << self
+      attr_accessor :program, :short_code
+    end
+    def self.account_id=(val)
+      Connection.default_params[:cbid] = val
+    end
+    def self.access_key=(val)
+      Connection.default_params[:key] = val
+    end
+  end
+end

data/lib/code_broker/connection.rb ADDED

@@ -0,0 +1,11 @@
+class CodeBroker
+  class Connection
+    include HTTParty
+    format :html
+    base_uri "https://codebroker.net/cb/gateway/get"
+    if ENV['CB_DEBUG']
+      debug_output $stderr # For debugging
+    end
+  end
+end

data/lib/code_broker/version.rb ADDED

@@ -0,0 +1,3 @@
+module CodeBroker
+  VERSION = "0.0.1"
+end

metadata ADDED

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: code_broker
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease:
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Marini
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-09-19 00:00:00 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 63
+        segments:
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id001
+description: Client library to interface with Code Broker
+email:
+- ben.marini@akqa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- REAME.md
+- Rakefile
+- code_broker.gemspec
+- lib/code_broker.rb
+- lib/code_broker/config.rb
+- lib/code_broker/connection.rb
+- lib/code_broker/version.rb
+homepage: ""
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project: code_broker
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: Client library to interface with Code Broker
+test_files: []