squab-client 1.4.0

data/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2013 Square Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,4 @@
+Squab Client
+=====
+
+This is the Squab Client directory.  Please see the root level directory for information on squab, using squab, and developing squab.

data/bin/squab-digest

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+#
+# A squab stream to e-mail script
+#
+
+require 'rubygems'
+require 'optparse'
+require 'ostruct'
+require 'pp'
+require 'net/smtp'
+
+require 'squab-client'
+
+options = OpenStruct.new
+options.days = 1
+options.sources = []
+options.to = []
+options.from = "squab-digest@example.com"
+options.today = Time.now.strftime("%a, %b %d")
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usarge #{__FILE__} [options]"
+  opts.on('-d', '--days DAYS', "Number of days to digest") do |arg|
+    options.days = arg.to_i
+  end
+  opts.on('-e', '--email EMAIL', "Where to send the digest") do |arg|
+    options.to.push(arg)
+  end
+  opts.on('-s', '--source SOURCE', 'Specify a source to digest.  Can be used multiple times') do |arg|
+    options.sources.push(arg)
+  end
+  opts.on('-a', '--api URL', "API URL for squab") do |arg|
+    options.api = arg
+  end
+  opts.on('-D', '--dry-run', "Don't send mail, output the message to stdout") do
+    options.dry = true
+  end
+end
+
+optparse.parse!
+
+sc = if options.api
+  Squab::Client.new(:api => options.api)
+else
+  Squab::Client.new()
+end
+
+if options.sources.empty?
+  $stderr.puts optparse
+  $stderr.puts "\n[ERROR] You must supply a source to digest (-s)"
+  exit 1
+end
+
+if options.to.empty?
+  $stderr.puts optparse
+  $stderr.puts "\n[ERROR] You must supply an email to send to (-e)"
+  exit 1
+end
+
+since = Time.now.to_i - (86400 * options.days.to_i)
+message = <<-EOM.gsub(/^\s+/, '')
+  From: #{options.from}
+  To: #{options.to.join(',')}
+  Subject: Squab Digest Report for #{options.today}
+EOM
+
+message << "\n\n"
+
+options.sources.each do |src|
+  search_params = { :source => src,
+                    :from => since }
+
+  res = JSON.parse(sc.search(search_params))
+  message << "#{src} events from the last #{options.days} days\n\n"
+  res.each do |event|
+    message << sprintf("%-16s -- %s\n", event['uid'], event['value'])
+  end
+  message << "\n\n"
+end
+
+if options.dry
+  puts message
+else
+  Net::SMTP.start('localhost', 25) do |smtp|
+    smtp.send_message message, options.from, options.to
+  end
+end

data/bin/squawk

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'squab-client'
+require 'optparse'
+
+options = {}
+options[:max_retry] = 3
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [options] [message]"
+  opts.on('-a', '--api URL', 'Set the API url to use') do |arg|
+    options[:api] = arg 
+  end
+  opts.on('-u', '--url URL', 'Set an explicit URL for your event') do |arg|
+    options[:url] = arg
+  end
+  opts.on('-U', '--user USER', 'Set an explicit user for your message') do |arg|
+    options[:user] = arg
+  end
+  opts.on('-S', '--source SOURCE', 'Set an explicit source for your message') do |arg|
+    options[:source] = arg
+  end
+  opts.on('-r', '--max-retry 3', "The maximum number of time to retry sending\n a message on failure (default: 3)") do |arg|
+    options[:max_retry] = arg
+  end
+  opts.on('--noverify', "Don't verify SSL.  You probably shouldn't do this") do |arg|
+    options[:no_verify] = true
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+optparse.parse!
+
+sq = if (options[:api].nil?)
+  Squab::Client.new
+else
+  Squab::Client.new(:api => options[:api])
+end
+
+if options[:user]
+  sq.uid = options[:user]
+end
+
+if options[:source]
+  sq.source = options[:source]
+end
+
+if (options[:no_verify])
+  sq.ssl_verify = false
+end
+
+if ARGV.length < 1
+  puts optparse
+  raise "You must provide a message to send to Squab"
+  exit
+end
+message = ARGV.join(' ')
+puts message
+
+urls = if options[:url].nil?
+  URI.extract(message)
+else
+  [options[:url]]
+end
+
+try_count = 0
+begin
+  if urls.length == 1
+    sq.send(message, urls.first)
+  elsif urls.length > 1
+    puts "Multiple URLs found, using #{urls.last}"
+    sq.send(message, urls.last)
+  else
+    sq.send(message)
+  end
+rescue SendEventFailed
+  try_count += 1
+  if try_count > options[:max_retry]
+    $stderr.puts "Failed to send message to squab, the server is not responding correctly"
+  else
+    sleep 1
+    retry
+  end
+end

data/lib/squab-client.rb

@@ -0,0 +1,167 @@
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+require 'json'
+require 'yaml'
+require 'etc'
+
+class SendEventFailed < StandardError
+end
+
+module Squab
+  class Client
+    attr_accessor :source, :uid, :api_url, :ssl_verify
+    attr_accessor :api_version_prefix, :events_prefix
+    # Opts accepts
+    # api => The API URL to hit
+    # user => The user to report
+    # source => the source to report
+    def initialize(opts={})
+      @source = get_my_source(opts[:source])
+      @uid = get_my_user(opts[:user])
+      parse_config
+      @api_url = get_api(opts[:api] || @config[:api])
+      @ssl_verify = @config['ssl_verify'] || true
+      @api_version_prefix = @config['api_prefix'] || '/api/v1'
+      @events_prefix = [@api_version_prefix, 'events'].join('/')
+    end
+
+    def send(event, url=nil)
+      payload = {
+        "uid" => @uid,
+        "source" => @source,
+        "value" => event,
+        "url" => url,
+      }.to_json
+      header = {'Content-Type' => 'application/json'}
+      req = Net::HTTP::Post.new(@events_prefix, initheader = header)
+      req.body = payload
+      try_count = 1
+      begin
+        http = Net::HTTP.new(@api_url.host, @api_url.port)
+        http = setup_ssl(http) if @api_url.scheme == "https"
+        response = http.request(req)
+      rescue EOFError, Errno::ECONNREFUSED => e
+        raise SendEventFailed, "Could not reach the Squab server"
+      end
+      response
+    end
+
+    def list_sources
+      req = make_request('sources')
+      get_req(req)
+    end
+
+    def list_users
+      req = make_request('users')
+      get_req(req)
+    end
+
+    def list_urls
+      req = make_request('urls')
+      get_req(req)
+    end
+
+    def get(max=5, since=nil)
+      req = if since
+        make_event_request("since/#{since.to_i}")
+      else
+        make_event_request("limit/#{max}")
+      end
+      get_req(req)
+    end
+
+    def get_from_event(event_num)
+      req = make_event_request("starting/#{event_num}")
+      get_req(req)
+    end
+
+    def get_from_user(username)
+      req = make_event_request("user/#{username}")
+      get_req(req)
+    end
+
+    def get_from_source(source)
+      req = make_event_request("source/#{source}")
+      get_req(req)
+    end
+
+    def simple_search(search_val)
+      req = make_event_request("search/value/#{search_val}/limit/5")
+      get_req(req)
+    end
+
+    def search(search_params)
+      req = Net::HTTP::Post.new([ @events_prefix, 'search' ].join('/'))
+      req.body = JSON.dump(search_params)
+      get_req(req)
+    end
+
+    def get_api(url)
+      url ? URI.parse(url) :  URI.parse(
+        "http://squab/"
+      )
+    end
+
+    def parse_config(file=nil)
+      # Default
+      config_file = file || '/etc/squab.yaml'
+      # Instance override
+      if File.exist?(config_file)
+        @config = YAML.load(File.open(config_file).read)
+      else
+        @config = {}
+      end
+    end
+
+    def get_my_source(source=nil)
+      source || File.basename($PROGRAM_NAME)
+    end
+
+    def get_my_user(username=nil)
+      username || Etc.getpwuid(Process.uid).name
+    end
+
+    private
+    def setup_ssl(http)
+      http.use_ssl = true
+      http.ca_file = OpenSSL::X509::DEFAULT_CERT_FILE 
+      if @ssl_verify
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      else
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        $stderr.puts("Bypassing SSL verification, this should only happen "+
+                     "during testing and development")
+      end
+      http.verify_depth = 5
+      http
+    end
+
+    def get_req(req, full_req=false)
+      http = Net::HTTP.new(@api_url.host, @api_url.port)
+      http = setup_ssl(http) if @api_url.scheme == "https"
+      resp = http.start { |h| h.request(req) }
+      if full_req
+        resp
+      else
+        resp.body
+      end
+    end
+
+    def make_event_request(to)
+      Net::HTTP::Get.new([ @events_prefix, to ].join('/'))
+    end
+
+    def make_request(to)
+      Net::HTTP::Get.new([ @api_version_prefix, to ].join('/'))
+    end
+  end
+end
+
+# Old name space, deprecated and should be removed eventually
+class SquabClient < Squab::Client
+  def initialize(api_url=nil, source=nil, uid=nil)
+    super(:api => api_url, :source => source, :user => uid)
+  end
+end
+

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: squab-client
+version: !ruby/object:Gem::Version 
+  hash: 7
+  prerelease: 
+  segments: 
+  - 1
+  - 4
+  - 0
+  version: 1.4.0
+platform: ruby
+authors: 
+- Grier Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-12-02 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: A client wrapper for the Squab API, also includes the CLI tool 'squawk' for quick message sending
+email: 
+- github@squareup.com
+executables: 
+- squawk
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.md
+files: 
+- lib/squab-client.rb
+- bin/squawk
+- bin/squab-digest
+- README.md
+- LICENSE.md
+has_rdoc: true
+homepage: http://github.com/square/squab
+licenses: 
+- Apache 2.0
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Squab client
+test_files: []
+