remocon 0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jumpei Matsuda
+
+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,91 @@
+# Remocon
+
+*remocon* is a CLI for Firebase Remote Config via its REST API.  
+Conditions and parameters are managed by YAML files.
+
+*This is still in beta. A diff mode should be supported when managing configs heavily.*
+
+## Usage
+
+You need to get an access token for your firebase project.
+
+```bash
+export FIREBASE_PROJECT_ID='your project id'
+export REMOTE_CONFIG_ACCESS_TOKEN='your access token'
+```
+
+### Get the current configs into your local
+
+```bash
+bundle exec remocon pull --dest=${path to dir}
+
+# you can see ${path to dir}/${FIREBASE_PROJECT_ID}/{paremeters.yml, conditions.yml, config.json, etag}
+```
+
+### Edit configs on your local
+
+Condition definitions and parameter definitions are separated. You should modify these files.
+
+*parameters.yml*
+
+```yaml
+key1: # key name
+  value: 100 # default value
+  conditions: 
+    condition1:
+      value: 200 # a value to be used if condition1 is satisfied
+    condition2:
+      file: path_to_file # you can use file content. the file content is used for a value
+```
+
+*conditions.yml*
+
+```yaml
+- name: condition1 # condition name
+  expression: device.os == 'android' # expression
+  tagColor: "INDIGO" # color name
+- name: condition2
+  expression: device.os == 'ios'
+  tagColor: CYAN
+```
+
+### Update configs on remote
+
+```bash
+bundle exec remocon push --source=${path to a json file} --etag=${string or path to a file}
+```
+
+## Installation
+
+```ruby
+gem 'remocon'
+```
+
+## Format
+
+### Parameters
+
+You can use String, Boolean, Integer, Json validators like below.
+
+```yaml
+key:
+  value: # optional (either of this or file is required). Raw value and hash are allowed.
+  file: # optional (either of this or value is required). File content value.
+  normalizer: # optional. Either of ["integer", "string", "boolean", "json", "void"] (default: void).
+  conditions: # optional. If you want use conditional values, then you need to create this section.
+    condition_name: # must be in condition definitions.
+      value: ...
+      file: ...
+```
+
+### Conditions
+
+It seems only three fields are supported by Remote Config. They are name, expression and tagColor.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jmatsu/remocon .
+
+## 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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'remocon'
+
+# 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/get_access_token

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -eu
+
+if type easy_install >/dev/null 2>&1; then
+    sudo easy_install --upgrade google-api-python-client
+else
+    sudo pip install --upgrade google-api-python-client
+fi
+
+get_access_token.py

data/bin/get_access_token.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+# python 2.x
+
+import sys
+from oauth2client.service_account import ServiceAccountCredentials
+
+def print_access_token():
+  argv = sys.argv
+	if (len(argv) != 2):
+    print >> sys.stderr, 'a filepath to service-account.json must be specified as the 1st argument.'
+    quit()
+  credentials = ServiceAccountCredentials.from_json_keyfile_name(
+      argv[1], ['https://www.googleapis.com/auth/firebase.remoteconfig'])
+  access_token_info = credentials.get_access_token()
+  print(access_token_info.access_token)
+
+print_access_token

data/bin/put_by_curl

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -eu
+
+etag_file="$1"
+config_json_file="$2"
+
+curl --compressed \
+    -H "Content-Type: application/json; UTF8" \
+    -H "If-Match: $(cat $etag_file)" \
+    -H "Authorization: Bearer ${REMOTE_CONFIG_ACCESS_TOKEN}" \
+    -X PUT "https://firebaseremoteconfig.googleapis.com/v1/projects/${FIREBASE_PROJECT_ID}/remoteConfig" \
+    -d "@$config_json_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/cmd/remocon

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'remocon'
+
+Remocon::CLI.start(ARGV)

data/lib/remocon.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'json'
+require 'thor'
+require 'active_support'
+require 'active_support/core_ext'
+require 'singleton'
+require 'open-uri'
+require 'fileutils'
+require 'net/http'
+
+require 'remocon/util/array'
+require 'remocon/util/hash'
+require 'remocon/util/string'
+
+require 'remocon/version'
+require 'remocon/type'
+
+require 'remocon/error/unsupported_type_error'
+require 'remocon/error/validation_error'
+
+require 'remocon/sorter/condition_sorter'
+require 'remocon/sorter/parameter_sorter'
+
+require 'remocon/dumper/condition_file_dumper'
+require 'remocon/dumper/parameter_file_dumper'
+
+require 'remocon/interpreter/condition_file_interpreter'
+require 'remocon/interpreter/parameter_file_interpreter'
+
+require 'remocon/normalizer/normalizer'
+require 'remocon/normalizer/boolean_normalizer'
+require 'remocon/normalizer/integer_normalizer'
+require 'remocon/normalizer/json_normalizer'
+require 'remocon/normalizer/string_normalizer'
+require 'remocon/normalizer/void_normalizer'
+require 'remocon/normalizer/type_normalizer_factory'
+
+require 'remocon/command/lib/interpreter_helper'
+
+require 'remocon/command/create_command'
+require 'remocon/command/pull_command'
+require 'remocon/command/push_command'
+require 'remocon/command/validate_command'
+
+require 'remocon/cli'

data/lib/remocon/cli.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Remocon
+  class CLI < ::Thor
+    desc 'create', 'Create a json to be pushed'
+    option :parameters, type: :string, required: true, desc: 'a filepath of parameters file'
+    option :conditions, type: :string, required: true, desc: 'a filepath of conditions file'
+    option :dest, type: :string, desc: 'a filepath or directory path of destination'
+    def create
+      execute(Remocon::Command::Create)
+    end
+
+    desc 'push', 'Upload remote configs based on a source json file'
+    class_option :source, type: :string, desc: 'a filepath of a source json file'
+    option :etag, type: :string, desc: 'a filepath or raw value of etag'
+    option :dest, type: :string, desc: 'a filepath or directory path of destination'
+    option :force, type: :boolean, default: false, desc: 'force to ignore some warnings'
+    def push
+      execute(Remocon::Command::Push)
+    end
+
+    desc 'pull', 'Pull remote configs'
+    option :dest, type: :string, desc: 'a filepath or directory path of destination'
+    def pull
+      execute(Remocon::Command::Pull)
+    end
+
+    desc 'validate', 'Validate yml files'
+    option :parameters, type: :string, required: true, desc: 'a filepath of parameters file'
+    option :conditions, type: :string, required: true, desc: 'a filepath of conditions file'
+    def validate
+      execute(Remocon::Command::Validate)
+    end
+
+    private
+
+    def execute(klass)
+      klass.new(options).run
+    end
+  end
+end

data/lib/remocon/command/create_command.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Remocon
+  module Command
+    class Create
+      include Remocon::InterpreterHelper
+
+      def initialize(opts)
+        @opts = opts
+
+        @project_id = ENV.fetch('FIREBASE_PROJECT_ID')
+        @conditions_filepath = @opts[:conditions]
+        @parameters_filepath = @opts[:parameters]
+        @dest_dir = File.join(@opts[:dest], @project_id) if @opts[:dest]
+
+        @cmd_opts = { validate_only: false }
+      end
+
+      def run
+        validate_options
+
+        artifact = {
+          conditions: condition_array,
+          parameters: parameter_hash
+        }.skip_nil_values.stringify_values
+
+        if @dest_dir
+          File.open(File.join(@dest_dir, 'config.json'), 'w+') do |f|
+            # remote config allows only string values ;(
+            f.write(JSON.pretty_generate(artifact))
+            f.flush
+          end
+        else
+          STDOUT.puts JSON.pretty_generate(artifact)
+        end
+
+        artifact
+      end
+
+      private
+
+      def validate_options
+        raise ValidationError, 'A condition file must exist' unless File.exist?(@conditions_filepath)
+        raise ValidationError, 'A parameter file must exist' unless File.exist?(@parameters_filepath)
+      end
+    end
+  end
+end

data/lib/remocon/command/lib/interpreter_helper.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Remocon
+  module InterpreterHelper
+    include Remocon::ConditionSorter
+    include Remocon::ParameterSorter
+
+    attr_reader :parameters_filepath, :conditions_filepath, :cmd_opts
+
+    def read_parameters
+      @read_parameters ||= begin
+        parameter_interpreter = Remocon::ParameterFileInterpreter.new(parameters_filepath)
+        parameter_interpreter.read(condition_names, cmd_opts)
+      end
+    end
+
+    def parameter_hash
+      @parameter_hash ||= sort_parameters(read_parameters.first)
+    end
+
+    def parameter_errors
+      @parameter_errors ||= read_parameters.second
+    end
+
+    def read_conditions
+      @read_conditions ||= begin
+        condition_interpreter = Remocon::ConditionFileInterpreter.new(conditions_filepath)
+        condition_interpreter.read(cmd_opts)
+      end
+    end
+
+    def condition_array
+      @condition_array ||= sort_conditions(read_conditions.first)
+    end
+
+    def condition_errors
+      @condition_errors ||= read_conditions.second
+    end
+
+    def condition_names
+      @condition_names ||= condition_array.map { |e| e[:name] }
+    end
+  end
+end

data/lib/remocon/command/pull_command.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Remocon
+  module Command
+    class Pull
+      include Remocon::InterpreterHelper
+
+      def initialize(opts)
+        @opts = opts
+
+        @project_id = ENV.fetch('FIREBASE_PROJECT_ID')
+        @token = ENV.fetch('REMOTE_CONFIG_ACCESS_TOKEN')
+        @url = "https://firebaseremoteconfig.googleapis.com/v1/projects/#{@project_id}/remoteConfig"
+        @dest_dir = File.join(@opts[:dest], @project_id) if @opts[:dest]
+
+        @cmd_opts = { validate_only: false }
+      end
+
+      def run
+        if @dest_dir
+          FileUtils.mkdir_p(@dest_dir)
+
+          raw_hash = JSON.parse(raw_json).with_indifferent_access
+
+          raise 'etag cannot be fetched. please try again' unless @etag
+
+          conditions, parameters = [raw_hash[:conditions] || [], raw_hash[:parameters] || {}]
+
+          File.open(File.join(@dest_dir, "conditions.yml"), 'w+') do |f|
+            f.write(JSON.parse(Remocon::ConditionFileDumper.new(sort_conditions(conditions)).dump.to_json).to_yaml)
+            f.flush
+          end
+
+          File.open(File.join(@dest_dir, "parameters.yml"), 'w+') do |f|
+            f.write(JSON.parse(Remocon::ParameterFileDumper.new(sort_parameters(parameters)).dump.to_json).to_yaml)
+            f.flush
+          end
+
+          File.open(File.join(@dest_dir, "config.json"), 'w+') do |f|
+            f.write(JSON.pretty_generate({ conditions: sort_conditions(conditions), parameters: sort_parameters(parameters) }))
+            f.flush
+          end
+
+          File.open(File.join(@dest_dir, 'etag'), 'w+') do |f|
+            f.write(@etag)
+            f.flush
+          end
+        else
+          STDOUT.puts raw_json
+        end
+      end
+
+      private
+
+      def raw_json
+        return @raw_json if @raw_json
+
+        @raw_json, @etag = open(@url, 'Authorization' => "Bearer #{@token}") do |io|
+          [io.read, io.meta['etag']]
+        end
+
+        @raw_json
+      end
+    end
+  end
+end