josef 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 659488d85b4d808b98bd81d506672e6e66d5b615df9333107d2cffd445ae71f2
+  data.tar.gz: d6b77ee7df6ac03d6fc2ec9061e90a034704b5d0336170ac195d244408eba788
+SHA512:
+  metadata.gz: 78417ff9f122b2dbbb9191790b576837efd938d2768b45ba58c6d5f47f54599b4215c48088774214ed9d86b53f44fa46d1d5dce07fd4ddbf4ffe8fb5b3282ceb
+  data.tar.gz: bb5b08e16a59084db95d132dc2fd21d3868eb0fcedd5e4b027cf3c80cb755aab4c51387400fda365a29b2fc66d67f88a575c51802c541c187c882e57aa4ded69

data/.editorconfig

@@ -0,0 +1,30 @@
+root = true
+
+[*]
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+tab_width = 8
+trim_trailing_whitespace = true
+
+[*.bat]
+end_of_line = crlf
+
+[*.gemspec]
+indent_size = 2
+
+[*.rb]
+indent_size = 2
+
+[*.yml]
+indent_size = 2
+
+[{*[Mm]akefile*,*.mak,*.mk,depend}]
+indent_style = tab
+
+[enc/*]
+indent_size = 2
+
+[reg*.[ch]]
+indent_size = 2

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+vendor/bundle
+.env
+*.json
+*.yml

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in josef.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    josef (0.1.0)
+      activesupport
+      google-api-client
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.8)
+    declarative (0.0.20)
+    declarative-option (0.1.0)
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    gems (1.2.0)
+    google-api-client (0.53.0)
+      google-apis-core (~> 0.1)
+      google-apis-generator (~> 0.1)
+    google-apis-core (0.3.0)
+      addressable (~> 2.5, >= 2.5.1)
+      googleauth (~> 0.14)
+      httpclient (>= 2.8.1, < 3.0)
+      mini_mime (~> 1.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+      rexml
+      signet (~> 0.14)
+      webrick
+    google-apis-discovery_v1 (0.2.0)
+      google-apis-core (~> 0.1)
+    google-apis-generator (0.2.0)
+      activesupport (>= 5.0)
+      gems (~> 1.2)
+      google-apis-core (~> 0.1)
+      google-apis-discovery_v1 (~> 0.0)
+      thor (>= 0.20, < 2.a)
+    googleauth (0.16.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    httpclient (2.8.3)
+    i18n (1.8.9)
+      concurrent-ruby (~> 1.0)
+    jwt (2.2.2)
+    memoist (0.16.2)
+    mini_mime (1.0.2)
+    minitest (5.14.4)
+    multi_json (1.15.0)
+    multipart-post (2.1.1)
+    os (1.1.1)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.1.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    signet (0.15.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    uber (0.1.0)
+    webrick (1.7.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  josef!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 jolantern
+
+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,77 @@
+# Josef
+
+## What's This?
+
+Josef is manage Google Group on Google Workspace cli tool. It can dump Google Groups, specific domain's in `domains.yml`. And, apply and dry run with dumped yaml.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'josef'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install josef
+
+## Usage
+
+### Environment Variables
+
+You can configure setting for domains file and actor with environment valiables.
+
+`GOOGLE_WORKSPACE_ACTOR` : Josef use Service Account Key, and Admin SDK. So, You must set Googlge Workspace Administrator's primary mail address.
+
+`DOMAINS_FILE_PATH` : Google Group API is include domain in List Groups request. Josef is not manage Domains. You can configure josef manage target domains in yaml file. Please see `domains.yaml.sample`
+
+### dump groups and members yaml file
+
+```sh
+josef dump
+```
+
+### dry run(show diff)
+
+```sh
+josef diff ./local_group_file.yml
+```
+
+### apply
+
+```
+josef apply ./local_group_file.yml
+```
+
+## 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/[USERNAME]/josef.
+
+## Future
+
+### Spec
+
+Josef not have test.
+
+### Oauth Token?
+
+This tool manages Google Groups based on yaml. Therefore, I think that the administrator of Google WorkSpace may run it in the local environment. If the purpose is achieved with the service account and you want to use oauth authentication, we will handle it.
+
+### Domain Management?
+
+I'm not thinking about domain management for now. It doesn't make sense to be able to add it (because it also requires changing the DNS server settings), and I think it's a little too big to be able to delete it.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "josef"
+
+# 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/domains.yml.sample

@@ -0,0 +1,3 @@
+domains:
+  - domain.sample.com
+  - ml.samlple.com

data/exe/josef

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "josef"
+
+Josef::Cli.start

data/josef.gemspec

@@ -0,0 +1,32 @@
+require_relative 'lib/josef/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "josef"
+  spec.version       = Josef::VERSION
+  spec.authors       = ["jolantern"]
+  spec.email         = ["j.o.lantern0422@gmail.com"]
+
+  spec.summary       = "josef is management google workspace mailing list command"
+  spec.description   = "manage google workspace mailing list(google group) command"
+  spec.homepage      = "https://github.com/j-o-lantern0422/josef"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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-api-client"
+  spec.add_dependency "thor"
+  spec.add_dependency "activesupport"
+end

data/lib/josef.rb

@@ -0,0 +1,12 @@
+require "josef/version"
+require "thor"
+require "google/apis/admin_directory_v1"
+require "googleauth"
+require "googleauth/stores/file_token_store"
+require "fileutils"
+require "josef/cli"
+
+
+module Josef
+  class Error < StandardError; end
+end

data/lib/josef/cli.rb

@@ -0,0 +1,34 @@
+require "josef/google_workspace/client"
+require "josef/remote"
+require "josef/diff"
+module Josef
+  class Cli < Thor
+    include Josef::GoogleWorkspace::Client
+    include Josef::Remote
+    include Josef::Diff
+    class_option :dry_run, :type => :boolean, :default => false
+
+    desc "dump", "dump google workspace group"
+    def dump
+      remote_dump
+    end
+
+    desc "diff [Path]", "print diff defferent local yaml and remote"
+    method_options path: :string
+    def diff(path)
+      local(path)
+      remote_diff(remote, local, "dry run")
+    end
+
+    desc "apply [Path]", "apply local yaml to Google Workspace"
+    def apply(path)
+      local(path)
+      remote_apply(local)
+    end
+
+    desc "console", "console"
+    def console
+      binding.irb
+    end
+  end
+end

data/lib/josef/diff.rb

@@ -0,0 +1,54 @@
+require "josef/remote"
+require "josef/local"
+module Josef
+  module Diff
+    include Josef::Remote
+    include Josef::Local
+    def changed?(local_group)
+      remote_group = remote.find{|g| g[:group_mail_address] == local_group[:group_mail_address]}
+      return false if local_group[:members].nil? || remote_group[:members].nil?
+      return false if local_group[:members].sort == remote_group[:members].sort
+
+      true
+    end
+
+    def be_create?(local_group)
+      remote.find{|g| g[:group_mail_address] == local_group[:group_mail_address]}.nil?
+    end
+
+    def be_delete?(remote_group)
+      local.find{|g| g[:group_mail_address] == remote_group[:group_mail_address]}.nil?
+    end
+
+    def remote_diff(remote, local, mode = "apply")
+      local.each do | local_group |
+        if be_create?(local_group)
+          puts "#{local_group[:group_mail_address]} will be create:#{mode}"
+          local_group[:members].each do | member |
+            puts "+ #{member}"
+          end
+        elsif changed?(local_group)
+          puts "#{local_group[:group_mail_address]} will be change:#{mode}"
+          remote_members = remote.find{|g| g[:group_mail_address] == local_group[:group_mail_address]}[:members]
+
+          add = local_group[:members] - remote_members
+          del = remote_members - local_group[:members]
+
+          add.each do | add_member |
+            puts "+ #{add_member}"
+          end
+
+          del.each do | del_member |
+            puts "- #{del_member}"
+          end
+        end
+      end
+
+      remote.each do | remote_group |
+        if be_delete?(remote_group)
+          puts "#{remote_group[:group_mail_address]} will be delete:#{mode}"
+        end
+      end
+    end
+  end
+end

data/lib/josef/google_workspace/client.rb

@@ -0,0 +1,37 @@
+require "josef/google_workspace/config"
+require "josef/google_workspace/group"
+
+OOB_URI = "urn:ietf:wg:oauth:2.0:oob".freeze
+APP_NAME = "Josef".freeze
+SCOPE = Google::Apis::AdminDirectoryV1::AUTH_ADMIN_DIRECTORY_GROUP
+
+module Josef
+  module GoogleWorkspace
+    module Client
+      include Josef::GoogleWorkspace::Config
+      include Josef::GoogleWorkspace::Group
+
+      def client
+        @_client ||= client!
+      end
+
+      def client!
+        service = Google::Apis::AdminDirectoryV1::DirectoryService.new
+        service.authorization = authorize!
+        service.authorization.fetch_access_token!
+
+        service
+      end
+
+      def authorize!
+        authorization = Google::Auth::ServiceAccountCredentials.make_creds(
+          json_key_io: File.open(credential_path),
+          scope: SCOPE)
+
+        authorization.sub = actor
+        authorization
+      end
+    end
+  end
+end
+

data/lib/josef/google_workspace/config.rb

@@ -0,0 +1,37 @@
+require "yaml"
+module Josef
+  module GoogleWorkspace
+    module Config
+      def credential_path
+        ENV["GOOGLE_WORKSPACE_CREDENTIAL_PATH"]
+      end
+
+      def token_path(path)
+        @_token_path ||= ENV["GOOGLE_WORKSPACE_TOKEN_PATH"] || path
+      end
+
+      def actor
+        @_actor ||= actor!
+      end
+
+      def actor!
+        if ENV["GOOGLE_WORKSPACE_ACTOR"].nil?
+          print("input actor primary mail address:")
+          return $stdin.gets.chomp!("\n")
+        end
+
+        ENV["GOOGLE_WORKSPACE_ACTOR"]
+      end
+
+      def domains(domains_file_path: nil)
+        path = domains_file_path || ENV["DOMAINS_FILE_PATH"]
+        if path.nil?
+          print "input your domains file path:"
+          path = $stdin.gets.chomp!("\n")
+        end
+        YAML.load_file(path)["domains"]
+      end
+    end
+  end
+end
+

data/lib/josef/google_workspace/group.rb

@@ -0,0 +1,33 @@
+require "josef/google_workspace/config"
+require "josef/google_workspace/members"
+module Josef
+  module GoogleWorkspace
+    module Group
+      include Josef::GoogleWorkspace::Config
+      include Josef::GoogleWorkspace::Members
+      def groups
+        @_groups ||= groups!
+      end
+
+      def groups!
+        domains.map do | domain |
+          client.list_groups(domain: domain).groups
+        end.flatten.compact
+      end
+
+      def create_group(group_mail_address)
+        group = ::Google::Apis::AdminDirectoryV1::Group.new(email: group_mail_address)
+
+        client.insert_group(group)
+      end
+
+      def delete_group(group_mail_address)
+        group = groups.find{|g| g.email == group_mail_address}
+
+        client.delete_group(group.id)
+      end
+    end
+  end
+end
+
+

data/lib/josef/google_workspace/members.rb

@@ -0,0 +1,27 @@
+module Josef
+  module GoogleWorkspace
+    module Members
+      def member_mail_addreses(group)
+        members_by(group)&.map do | member |
+          member.email
+        end
+      end
+
+      def members_by(group)
+        client.list_members(group.id).members
+      end
+
+      def add_member(group_mail_address, member_mail_address)
+        member = ::Google::Apis::AdminDirectoryV1::Member.new(email: member_mail_address)
+        group = groups.find{|g| g.email == group_mail_address}
+        client.insert_member(group.id, member)
+      end
+
+      def del_member(group_mail_address, member_mail_address)
+        group = groups.find{|g| g.email == group_mail_address}
+        member = members_by(group).find{ |member| member.email == member_mail_address }
+        client.delete_member(group.id, member.id)
+      end
+    end
+  end
+end

data/lib/josef/local.rb

@@ -0,0 +1,14 @@
+require "josef/google_workspace/client"
+require "active_support"
+require "active_support/core_ext"
+module Josef
+  module Local
+    def local(local_file = nil)
+      @_local ||= local!(local_file)
+    end
+
+    def local!(local_file)
+      YAML.load_file(local_file).map{|h| h.deep_symbolize_keys}
+    end
+  end
+end

data/lib/josef/remote.rb

@@ -0,0 +1,55 @@
+require "josef/google_workspace/client"
+require "josef/google_workspace/group"
+require "active_support"
+require "active_support/core_ext"
+module Josef
+  module Remote
+    include Josef::GoogleWorkspace::Client
+    include Josef::GoogleWorkspace::Group
+    def remote
+      @_remote ||= remote!
+    end
+
+    def remote!
+      groups.map do | group |
+        { group_mail_address: group.email, members: member_mail_addreses(group) }
+      end
+    end
+
+    def remote_dump
+      YAML.dump(remote.map{|h| h.deep_stringify_keys}, File.open('dump.yml', 'w'))
+    end
+
+    def remote_apply(local)
+      remote_diff(remote, local)
+      local.each do | local_group |
+        if be_create?(local_group)
+          create_group(local_group[:group_mail_address])
+
+          local_group[:members].each do | member |
+            add_member(local_group[:group_mail_address], member)
+          end
+        elsif changed?(local_group)
+          remote_members = remote.find{|g| g[:group_mail_address] == local_group[:group_mail_address]}[:members]
+
+          add = local_group[:members] - remote_members
+          del = remote_members - local_group[:members]
+
+          add.each do | add_member_mail_address |
+            add_member(local_group[:group_mail_address], add_member_mail_address)
+          end
+
+          del.each do | del_member_mail_address |
+            del_member(local_group[:group_mail_address], del_member_mail_address)
+          end
+        end
+      end
+
+      remote.each do | remote_group |
+        if be_delete?(remote_group)
+          delete_group(remote_group[:group_mail_address])
+        end
+      end
+    end
+  end
+end

data/lib/josef/version.rb

@@ -0,0 +1,3 @@
+module Josef
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: josef
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jolantern
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  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: 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: activesupport
+  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'
+description: manage google workspace mailing list(google group) command
+email:
+- j.o.lantern0422@gmail.com
+executables:
+- josef
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- domains.yml.sample
+- exe/josef
+- josef.gemspec
+- lib/josef.rb
+- lib/josef/cli.rb
+- lib/josef/diff.rb
+- lib/josef/google_workspace/client.rb
+- lib/josef/google_workspace/config.rb
+- lib/josef/google_workspace/group.rb
+- lib/josef/google_workspace/members.rb
+- lib/josef/local.rb
+- lib/josef/remote.rb
+- lib/josef/version.rb
+homepage: https://github.com/j-o-lantern0422/josef
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/j-o-lantern0422/josef
+  source_code_uri: https://github.com/j-o-lantern0422/josef
+  changelog_uri: https://github.com/j-o-lantern0422/josef
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: josef is management google workspace mailing list command
+test_files: []