embulk-plugin-redis 0.1.3 → 0.1.4

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -1,37 +1,78 @@
-# Embulk input/output plugin for Redis
+# Embulk input plugin for Redis
 
-This [Embulk](https://github.com/embulk/embulk) output plugin writes records to a json column of a table.
+## Generic
 
-This plugin runs without transaction for now.
+### Overview
+
+* **Plugin type**: input
+* **Resume supported**: no
 
 ## Configuration
 
-- **host** Hostname of the Redis server (string, default: "localhost")
-- **port** Port of the Redis server (integer, default: 6379)
-- **db** Database number (integer, default: 0)
-- **key_prefix** Key prefix for input/output plugin (string)
-- **encode** Encoding in Redis
- - json: Stored as a JSON string. GET/SET commands can access it (string)
- - hash: Stored as a Hash. H* commands such as HMGET/HMSET can access it (string, output only)
-- **key** Column name used for a key in Redis (string, required: output only)
+- **host**: Hostname of the Redis server (string, default: "localhost")
+- **port**: Port of the Redis server (integer, default: 6379)
+- **db**: Database number (integer, default: 0)
+- **key_prefix**: Key prefix for input/output plugin (string, default:"")
+- **encode**: Encoding in Redis (string, default: "json")
+ - json: Stored as a JSON string. GET/SET commands can access it
+ - hash: Stored as a Hash. H* commands such as HMGET/HMSET can access it
+- **columns**: Hash records that has the following two fields (array, default:[])
+ - name: Name of the column
+ - type: Column types as follows
+    - boolean
+    - long
+    - double
+    - string
+    - timestamp
 
 ### Example
 
 ```yaml
-out:
+in:
   type: redis
   host: localhost
   port: 6379
   db: 0
-  key: user_name
   key_prefix: user_
-  encode: hash
+  encode: json
+  columns:
+  - {name: id, type: long}
+  - {name: account, type: long}
+  - {name: time, type: timestamp}
+  - {name: purchase, type: timestamp}
+  - {name: comment, type: string}
+  - {name: admin, type: boolean}
+```
 
-in:
+# Embulk output plugin for Redis
+
+## Generic
+
+### Overview
+
+* **Plugin type**: output
+* **Resume supported**: no
+
+## Configuration
+
+- **host**: Hostname of the Redis server (string, default: "localhost")
+- **port**: Port of the Redis server (integer, default: 6379)
+- **db**: Database number (integer, default: 0)
+- **key_prefix**: Key prefix for input/output plugin (string, default:"")
+- **encode**: Encoding in Redis (string, default: "json")
+ - json: Stored as a JSON string. GET/SET commands can access it
+ - hash: Stored as a Hash. H* commands such as HMGET/HMSET can access it
+- **key**: Column name used for a key in Redis (string, required)
+
+### Example
+
+```yaml
+out:
   type: redis
   host: localhost
   port: 6379
   db: 0
+  key: id
   key_prefix: user_
   encode: json
 ```

data/embulk-plugin-redis.gemspec

@@ -1,9 +1,9 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "embulk-plugin-redis"
-  gem.version       = "0.1.3"
+  gem.version       = "0.1.4"
 
-  gem.summary       = %q{Embulk plugin for Redis}
+  gem.summary       = %q{Embulk input/output plugins for Redis}
   gem.description   = gem.summary
   gem.authors       = ["Mitsunori Komatsu"]
   gem.email         = ["komamitsu@gmail.com"]

data/lib/embulk/input_redis.rb

@@ -13,36 +13,77 @@ module Embulk
         'db' => config.param('db', :integer, :default => 0),
         'key_prefix' => config.param('key_prefix', :string, :default => ''),
         'encode' => config.param('encode', :string, :default => 'json'),
+        'columns' =>
+          config.param('columns', :array, :default => []).inject({}){|a, col|
+            a[col['name']] = col['type'].to_sym
+            a
+          },
+        'rows' => 0
       }
-      threads = config.param('threads', :integer, default: 1)
 
-      columns = [
-        Column.new(0, 'key', :string),
-        Column.new(1, 'value', :string),
-      ]
+      columns = task['columns'].map.with_index{|(name, type), i|
+        Column.new(i, name, type)
+      }
 
       puts "Redis input started."
-      commit_reports = yield(task, columns, threads)
+      commit_reports = yield(task, columns, 1)
       puts "Redis input finished. Commit reports = #{commit_reports.to_json}"
 
       return {}
     end
 
+    def deserialize_element(x)
+      @task['columns'].map{|(name, type)|
+        begin
+          val = x[name]
+          case type.to_sym  # Converted to String implicitly?
+          when :boolean
+            if val.is_a?(TrueClass) || val.is_a?(FalseClass)
+              val
+            else
+              downcased_val = val.downcase
+              case downcased_val
+              when 'true' then true
+              when 'false' then false
+              else nil
+              end
+            end
+          when :long
+            Integer(val)
+          when :double
+            Float(val)
+          when :string
+            val
+          when :timestamp
+            Time.parse(val)
+          else
+            raise "Shouldn't reach here: val:#{val}, col_name:#{name}, col_type:#{type}"
+          end
+        rescue => e
+          STDERR.puts "Failed to deserialize: val:#{val}, col_name:#{name}, col_type:#{type}, error:#{e.inspect}"
+        end
+      }
+    end
+
     def run
       puts "Redis input thread #{@index}..."
-
       r = Redis.new(:host => @task['host'], :port => @task['port'], :db => @task['db'])
       r.keys("#{@task['key_prefix']}*").each do |k|
-        # TODO: Use MGET or something
         case @task['encode']
         when 'json'
           v = r.get(k)
-          @page_builder.add([k, v])
+          x = JSON.parse(v)
+          @page_builder.add(deserialize_element(x))
+        when 'hash'
+          x = r.hgetall(k)
+          @page_builder.add(deserialize_element(x))
         end
+        @task['rows'] += 1
       end
       @page_builder.finish  # don't forget to call finish :-)
 
       commit_report = {
+        "rows" => @task['rows']
       }
       return commit_report
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embulk-plugin-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -59,7 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2
-description: Embulk plugin for Redis
+description: Embulk input/output plugins for Redis
 email:
 - komamitsu@gmail.com
 executables: []
@@ -67,7 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - embulk-plugin-redis.gemspec
@@ -86,17 +86,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1426750318875487507
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1426750318875487507
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Embulk plugin for Redis
+summary: Embulk input/output plugins for Redis
 test_files: []
-has_rdoc: false

data/Gemfile.lock

@@ -1,19 +0,0 @@
-PATH
-  remote: .
-  specs:
-    embulk-plugin-redis (0.1.0)
-      redis (>= 3.0.5)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    rake (10.4.2)
-    redis (3.0.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  embulk-plugin-redis!
-  rake (>= 0.9.2)