dynamodb-streams-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7f611a8a685dfc1974b92e2a2bb10458858a609
-  data.tar.gz: 84da7c12fd34d9d907754f2c834bd641c5ff29f5
+  metadata.gz: cc0aa590a3b2c835e20cf06b6a5f3b05d8dcc63f
+  data.tar.gz: 6c726caf62c67d0616568029f1b3a421a5a74310
 SHA512:
-  metadata.gz: 19b1fcf3ec4d47ef2cbaa6b186c929a044486c65e3a756cc4af672670b323c12a06e8bfbb3bae28aee3b0cf810a06909c93680b665209c980dee683b5c4ffe48
-  data.tar.gz: d580a5092c5522ebef33a8e49bde4a78ea39911239ced5232565bd55bc2b732ec3d13db5afaab68484805b65f75b7555a3fa4c216cac86cf1541c99d0eb8227a
+  metadata.gz: f73c51247af46e2a1570af218b20759f9026cdc6ce4463795eb8bcf52c53def4e78d264f6c9d3d46373b6146708307da111b6e2fa7815302e1fa53c1203b4cd7
+  data.tar.gz: 9abc3e1ae742ead23924aaddf815cffe077243c15eb2816a1480c8218abeb2b17d7526cec0eaee99c1919e7d057239e498bb06e1aae3360d4679065a8ca0447a

data/README.md

@@ -21,6 +21,9 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+require 'dynamodb/streams/client'
+require 'pp'
+
 client = DynamoDB::Streams::Client.new(
   access_key_id: 'YOUR_ACCESS_KEY_ID',
   secret_access_key: 'YOUR_SECRET_ACCESS_KEY',
@@ -34,3 +37,27 @@ pp client.query('ListStreams')
 #      "...",
 #      "..."]}
 ```
+
+## CLI
+
+```sh
+$ dynamodb-streams
+Commands:
+  dynamodb-streams describe_stream STREAM_ID                                  # Returns information about a stream
+  dynamodb-streams get_records SHARD_ITERATOR                                 # Retrieves the stream records
+  dynamodb-streams get_shard_iterator STREAM_ID SHARD_ID SHARD_ITERATOR_TYPE  # Returns a shard iterator
+  dynamodb-streams help [COMMAND]                                             # Describe available commands or one specific command
+  dynamodb-streams list_streams                                               # Returns an array of stream IDs
+
+Options:
+  -k, [--access-key=ACCESS-KEY]
+  -s, [--secret-key=SECRET-KEY]
+  -e, [--endpoint=ENDPOINT]
+  -r, [--region=REGION]
+```
+
+### Follow record
+
+```sh
+dynamodb-streams get_records xxxxxxxx-xxxx-... -f --limit 10
+```

data/bin/dynamodb-streams

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("#{File.dirname __FILE__}/../lib")
+require 'rubygems'
+require 'dynamodb/streams/client'
+
+DynamoDB::Streams::Client::CLI.start(ARGV)

data/dynamodb-streams-client.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'thor'
+  spec.add_dependency 'deep_merge'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 end

data/lib/dynamodb/streams/client.rb

@@ -7,7 +7,10 @@ require 'stringio'
 require 'zlib'
 require 'uri'
 
+require 'thor'
+
 require 'dynamodb/streams/client/version'
+require 'dynamodb/streams/client/cli'
 
 class DynamoDB::Streams::Client
   class Error < StandardError
@@ -110,10 +113,12 @@ class DynamoDB::Streams::Client
 
     if res_code != 200 or __type
       errmsg = if __type
+                 res_data_msg = res_data['message'] || res_data['Message'] || __type
+
                  if @debug
-                   "#{__type}: #{res_data['message'] || res_data['Message']}"
+                   "#{__type}: #{res_data_msg}"
                  else
-                   "#{res_data['message'] || res_data['Message']}"
+                   "#{res_data_msg}"
                  end
                else
                  "#{res_code} #{res_msg}"

data/lib/dynamodb/streams/client/cli.rb

@@ -0,0 +1,103 @@
+require 'deep_merge'
+
+class DynamoDB::Streams::Client::CLI < Thor
+  ITOR_WAIT = 0.3
+
+  class_option 'access-key', :aliases => '-k'
+  class_option 'secret-key', :aliases => '-s'
+  class_option 'endpoint',   :aliases => '-e'
+  class_option 'region',     :aliases => '-r'
+
+  desc 'list_streams', 'Returns an array of stream IDs'
+  def list_streams
+    res_data = iterate('StreamId') do |rh|
+      client.query('ListStreams', rh)
+    end
+
+    puts JSON.pretty_generate(res_data)
+  end
+
+  desc 'describe_stream STREAM_ID', 'Returns information about a stream'
+  def describe_stream(stream_id)
+    req_hash = {'StreamId' => stream_id}
+
+    res_data = iterate('ShardId', req_hash) do |rh|
+      client.query('DescribeStream', rh)
+    end
+
+    puts JSON.pretty_generate(res_data)
+  end
+
+  desc 'get_shard_iterator STREAM_ID SHARD_ID SHARD_ITERATOR_TYPE', 'Returns a shard iterator'
+  option 'sequence-number'
+  def get_shard_iterator(stream_id, shard_id, shard_iterator_type)
+    req_hash = {
+      'StreamId'          => stream_id,
+      'ShardId'           => shard_id,
+      'ShardIteratorType' => shard_iterator_type.upcase,
+    }
+
+    if seq_num = options['sequence-number']
+      req_hash['SequenceNumber'] = seq_num
+    end
+
+    res_data = client.query('GetShardIterator', req_hash)
+    puts JSON.pretty_generate(res_data)
+  end
+
+  desc 'get_records SHARD_ITERATOR', 'Retrieves the stream records'
+  option 'limit', :type => :numeric
+  option 'follow', :aliases => '-f'
+  def get_records(shard_iterator)
+    req_hash = {'ShardIterator' => shard_iterator}
+    req_hash['Limit'] = options['limit'] if options['limit']
+
+    loop do
+      res_data = client.query('GetRecords', req_hash)
+      puts JSON.pretty_generate(res_data)
+      next_shard_iterator = res_data['NextShardIterator']
+
+      unless options['follow'] and next_shard_iterator
+        break
+      end
+
+      req_hash['ShardIterator'] = next_shard_iterator
+    end
+  end
+
+  no_commands do
+    def iterate(item, req_hash = {})
+      res_data = {}
+
+      list = proc do |last_evaluated|
+        req_hash["ExclusiveStart#{item}"] = last_evaluated if last_evaluated
+        resp = yield(req_hash)
+        res_data.deep_merge!(resp)
+        resp["LastEvaluated#{item}"]
+      end
+
+      le = nil
+
+      loop do
+        le = list.call(le)
+        break unless le
+      end
+
+      res_data.delete("LastEvaluated#{item}")
+      res_data
+    end
+
+    def client
+      return @client if @client
+
+      client_options = {
+        :access_key_id     => options.fetch('access-key', ENV['AWS_ACCESS_KEY_ID']),
+        :secret_access_key => options.fetch('secret-key', ENV['AWS_SECRET_ACCESS_KEY']),
+        :endpoint          => options.fetch('endpoint',   ENV['DYNAMODB_STREAMS_ENDPOINT']),
+        :region            => options['region'],
+      }
+
+      @client = DynamoDB::Streams::Client.new(client_options)
+    end
+  end
+end

data/lib/dynamodb/streams/client/version.rb

@@ -1,7 +1,7 @@
 module DynamoDB
   module Streams
     class Client
-      VERSION = '0.0.2'
+      VERSION = '0.0.3'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamodb-streams-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Genki Sugawara
@@ -10,6 +10,34 @@ bindir: bin
 cert_chain: []
 date: 2014-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: deep_merge
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +69,8 @@ dependencies:
 description: DynamoDB Streams client.
 email:
 - sgwr_dts@yahoo.co.jp
-executables: []
+executables:
+- dynamodb-streams
 extensions: []
 extra_rdoc_files: []
 files:
@@ -50,8 +79,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/dynamodb-streams
 - dynamodb-streams-client.gemspec
 - lib/dynamodb/streams/client.rb
+- lib/dynamodb/streams/client/cli.rb
 - lib/dynamodb/streams/client/version.rb
 homepage: https://github.com/winebarrel/dynamodb-streams-client
 licenses: