simple_bigtable_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7cc5ced6876896f8ffe9df3d6a766147f5bfc940e1faadc817128055577ae5e8
+  data.tar.gz: e2f4b287e0eea4b676fbc1339bbe2cf431404d01d2f1705672727cfe96d66eb4
+SHA512:
+  metadata.gz: 930890bef91af501b2a8b24943e473204696d5f3c641d3e966fac312235300923bdc36933a0586bcf87b77fceb67fd753862bceec5adf756b9894d63116323b2
+  data.tar.gz: dc866074f4279f9bd600be250b020603facafdda8a234949c42f39a2bcdf80c7cf163ac84ac0c7114b12c1235d4b53ebd86b64fb1eda6474826f664f69aae9b4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fonsan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    simple_bigtable_client (0.1.0)
+      google-cloud-bigtable (~> 0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    google-cloud-bigtable (0.1.0)
+      google-cloud-core (~> 1.1)
+      google-gax (~> 1.0)
+      grpc-google-iam-v1 (~> 0.6.9)
+    google-cloud-core (1.2.2)
+      google-cloud-env (~> 1.0)
+    google-cloud-env (1.0.2)
+      faraday (~> 0.11)
+    google-gax (1.3.0)
+      google-protobuf (~> 3.2)
+      googleapis-common-protos (>= 1.3.5, < 2.0)
+      googleauth (~> 0.6.2)
+      grpc (>= 1.7.2, < 2.0)
+      rly (~> 0.2.3)
+    google-protobuf (3.6.1)
+    googleapis-common-protos (1.3.7)
+      google-protobuf (~> 3.0)
+      googleapis-common-protos-types (~> 1.0)
+      grpc (~> 1.0)
+    googleapis-common-protos-types (1.0.2)
+      google-protobuf (~> 3.0)
+    googleauth (0.6.4)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    grpc (1.14.1)
+      google-protobuf (~> 3.1)
+      googleapis-common-protos-types (~> 1.0.0)
+    grpc-google-iam-v1 (0.6.9)
+      googleapis-common-protos (>= 1.3.1, < 2.0)
+      grpc (~> 1.0)
+    jwt (2.1.0)
+    memoist (0.16.0)
+    multi_json (1.13.1)
+    multipart-post (2.0.0)
+    os (1.0.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rly (0.2.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    signet (0.8.1)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simple_bigtable_client!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Fonsan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# SimpleBigtableClient
+
+Simple abstraction on top of https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-bigtable
+
+Which is at the time of writing currently under alpha
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_bigtable_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_bigtable_client
+
+## Usage
+
+The main point of this gem is to simplify the interfaces when reading and writing to bigtable
+
+### Reading
+
+Turns this
+```ruby
+require 'google/cloud/bigtable/v2'
+bigtable_client = Google::Cloud::Bigtable::V2.new
+formatted_table_name = Google::Cloud::Bigtable::V2::BigtableClient.table_path("project", "instance", "table")
+bigtable_client.read_rows(formatted_table_name).each do |cell_chunk|
+  cell_chunk # => <Google::Bigtable::V2::ReadRowsResponse: chunks: [<Google::Bigtable::V2::ReadRowsResponse::CellChunk: row_key:....
+end
+```
+
+Into
+```ruby
+require 'simple_bigtable_client'
+client = SimpleBigTableClient.new('instance') # Uses ENV['GOOGLE_CLOUD_PROJECT']
+client.read_rows do |row|
+  row #=> {_row_key: 'a', b: 'c'}
+end
+```
+
+### Writing
+
+Turns
+
+```ruby
+require 'google/cloud/bigtable/v2'
+bigtable_client = Google::Cloud::Bigtable::V2.new
+formatted_table_name = Google::Cloud::Bigtable::V2::BigtableClient.table_path("project", "instance", "table")
+entries = [
+  {
+    row_key: 'test',
+    mutations: [
+      {
+        set_cell: {
+          column_qualifier: 'a',
+          family_name: 'cf_v1',
+          value: 'value'
+        }
+      },
+      {
+        set_cell: {
+          column_qualifier: 'b',
+          family_name: 'cf_v1',
+          value: 'value2'
+        }
+      }
+    ]
+  },
+  {
+    row_key: 'test2',
+    mutations: [
+      {
+        set_cell: {
+          column_qualifier: 'a',
+          family_name: 'cf_v1',
+          value: 'value'
+        }
+      },
+      {
+        set_cell: {
+          column_qualifier: 'b',
+          family_name: 'cf_v1',
+          value: 'value2'
+        }
+      }
+    ]
+  }
+]
+bigtable_client.mutate_rows(formatted_table_name, entries).each do |result|
+  p result
+end
+```
+
+Into
+
+```ruby
+require 'simple_bigtable_client'
+client = SimpleBigTableClient.new('instance') # Uses ENV['GOOGLE_CLOUD_PROJECT']
+entries = {
+  first: {a: 'b', c: 'd'},
+  second: {e: 'f'},
+}
+subject.mutate_rows('table', 'column_family', entries) do |result|
+  p result
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Fonsan/simple_bigtable_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SimpleBigtableClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Fonsan/simple_bigtable_client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_bigtable_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_bigtable_client.rb

@@ -0,0 +1,71 @@
+require "simple_bigtable_client/version"
+require 'google/cloud/bigtable/v2'
+
+class SimpleBigtableClient
+  def initialize(instance, project_id: ENV['GOOGLE_CLOUD_PROJECT'], bigtable_client: Google::Cloud::Bigtable::V2.new)
+    @instance = instance
+    @bigtable_client = bigtable_client
+    @project_id = project_id
+  end
+
+  def read_rows(table, column_family, rows: nil, filter: nil, limit: nil, options: nil)
+    return to_enum(
+      __method__,
+      table,
+      column_family,
+      rows: rows,
+      filter: filter,
+      limit: limit,
+      options: options
+    ) unless block_given?
+    cell_chunk_enumerator = @bigtable_client.read_rows(
+      table_name(table),
+      rows: rows,
+      filter: filter,
+      rows_limit: limit,
+      options: options
+    )
+    prev_row_key = nil
+    row_enumerator = cell_chunk_enumerator.lazy.flat_map(&:chunks).chunk do |cell_chunk|
+      if cell_chunk.row_key == ""
+        prev_row_key
+      else
+        prev_row_key = cell_chunk.row_key
+      end
+    end
+    row_enumerator.each do |row_key, cell_chunks|
+      row = cell_chunks.each_with_object(_row_key: row_key) do |cell_chunk, acc|
+        acc[cell_chunk.qualifier.value.to_sym] = cell_chunk.value
+      end
+      yield(row)
+    end
+  end
+
+  def mutate_rows(table, column_family, enumerator, slice_size: 100_000)
+    enumerator.each_slice(slice_size) do |slice|
+      entries = slice.map do |row_key, cells|
+        {
+          row_key: row_key.to_s,
+          mutations: cells.map do |column_qualifier, value|
+            {
+              set_cell: {
+                column_qualifier: column_qualifier.to_s,
+                family_name: column_family,
+                value: value.to_s
+              }
+            }
+          end
+        }
+      end
+      @bigtable_client.mutate_rows(table_name(table), entries).each do |element|
+        yield element if block_given?
+      end
+    end
+  end
+
+  private
+
+  def table_name(table)
+    Google::Cloud::Bigtable::V2::BigtableClient.table_path(@project_id, @instance, table)
+  end
+end

data/lib/simple_bigtable_client/version.rb

@@ -0,0 +1,3 @@
+class SimpleBigtableClient
+  VERSION = "0.1.0"
+end

data/simple_bigtable_client.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_bigtable_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_bigtable_client"
+  spec.version       = SimpleBigtableClient::VERSION
+  spec.authors       = ["Fonsan"]
+  spec.email         = ["fonsan@gmail.com"]
+
+  spec.summary       = %q{A simple abstraction of reading and writing to bigtable}
+  spec.description   = %q{A simple abstraction of reading and writing to bigtable}
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "google-cloud-bigtable", "~> 0.1.0"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: simple_bigtable_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fonsan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-bigtable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple abstraction of reading and writing to bigtable
+email:
+- fonsan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_bigtable_client.rb
+- lib/simple_bigtable_client/version.rb
+- simple_bigtable_client.gemspec
+homepage: 
+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.7.7
+signing_key: 
+specification_version: 4
+summary: A simple abstraction of reading and writing to bigtable
+test_files: []