algolia-indices 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2a3c0af82c1678abce5e87b0ef7efb742da491bda0f2dfc07a2fd702a2b9e62
-  data.tar.gz: 61dc872342172b72207b422144e554a6ca965684312408c94d8b38c70e7d7ffe
+  metadata.gz: 39560bd31744ca72081fc48087e1de62c6505012c36bc2ab4761166024a4d790
+  data.tar.gz: a473ea29089945454cf0d19f00b1a36dd1234be1dbd2ffe2f59fe67ce1d9bed0
 SHA512:
-  metadata.gz: c3c8694387ecef634491de40a99b43e484028a78d0a45256f466b8e97786ff74849344dcd13948b5aef085d30d1fbbfe70c3ff97558e75e03208068c9408fa56
-  data.tar.gz: af5d6129cda532ea78a038c2864a8d61520067f1547d21a16e15ad7c7a7ce80f9fd9f00cbd0ad11eef4858a1fa232cc4f2519995b8531c5c360e753f7b4cfce5
+  metadata.gz: 49c9f8b2e068f74a37147d6dd4951ae4f941f52ff7960b0dc024627514e83d4dc216d86c6de31b84181f381ed6df970bfd87d93edb6faa819ddc3a564ce03c54
+  data.tar.gz: e22e02b05bfd1e8c98252d50b9222e46fee0e30f729e8c31be6fe987efdc0485ee004c00250115b56547a5a48ccc7f36a720919234049aa57f31edf083ed92e1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia-indices (0.1.0)
+    algolia-indices (0.2.0)
       faraday (~> 0.15.3)
       thor (~> 0.20.3)
 

data/README.md

@@ -1,6 +1,9 @@
 # algolia-indices
 
-A command line tool for [Algolia](https://www.algolia.com).
+A command line tool for [Algolia](https://www.algolia.com). algolia-indices has the following features:
+
+* **Import records**: You can import the record of the yaml file into the specified algolia index.
+* **Clear an index's context**: You can clear records from specified algolia index.   
 
 ## Installation
 
@@ -20,7 +23,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO
+```sh
+# Import the record of the yaml file into the specified algolia index
+$ algolia-indices import [API-KEY] [APPLICATION-ID] [INDEX-NAME] [FILE-PATH]
+
+# Clear records from specified algolia index
+$ algolia-indices clear [API-KEY] [APPLICATION-ID] [INDEX-NAME]
+```
+
+### Algolia API-Key
+
+You must generate an API key that gave the Add object and Delete Object permissions.
+
+see [Algolia API Key document](https://www.algolia.com/doc/guides/security/api-keys/#api-key-restrictions).
+
+### Import data format
+
+Create data source in `yaml` format.
+
+```yaml
+records:
+  - name: sample_restaurant1
+  - name: sample_restaurant2
+
+```
 
 ## Development
 

data/lib/algolia/indices/cli.rb

@@ -5,7 +5,7 @@ require 'algolia/indices/converter'
 module Algolia
   module Indices
     class CLI < Thor
-      desc "import [API-KEY] [APPLICATION-ID] [INDEX-NAME] [FILE-PATH]", "import records to specified Algolia index"
+      desc 'import [API-KEY] [APPLICATION-ID] [INDEX-NAME] [FILE-PATH]', 'Import records to specified algolia index'
       def import(api_key, application_id, index_name, path)
         puts 'Import records to Algolia'
         converter = Algolia::Indices::Converter.load(path)
@@ -13,6 +13,14 @@ module Algolia
         client.batch_write_operations(converter.batch_write_operations_request_paramters)
         puts 'Finished'
       end
+
+      desc 'clear [API-KEY] [APPLICATION-ID] [INDEX-NAME]', 'Clear records from specified algolia index'
+      def clear(api_key, application_id, index_name)
+        puts "Clear an index: #{index_name} content"
+        client = Algolia::Indices::Client.new(api_key, application_id, index_name)
+        client.clear_index
+        puts 'Finished'
+      end
     end
   end
 end

data/lib/algolia/indices/client.rb

@@ -15,6 +15,10 @@ module Algolia
         http_post(batch_write_operations_path, parameters)
       end
 
+      def clear_index
+        http_post(clear_index_path)
+      end
+
       private
 
       def http_client
@@ -34,7 +38,7 @@ module Algolia
         }
       end
 
-      def http_post(path, parameters = {})
+      def http_post(path, parameters = {}.to_json)
         http_client.post do |req|
           req.url path
           req.body = parameters
@@ -48,6 +52,10 @@ module Algolia
       def batch_write_operations_path
         "/1/indexes/#{@index_name}/batch"
       end
+
+      def clear_index_path
+        "/1/indexes/#{@index_name}/clear"
+      end
     end
   end
 end

data/lib/algolia/indices/version.rb

@@ -1,5 +1,5 @@
 module Algolia
   module Indices
-    VERSION = "0.1.0"
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia-indices
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - m-nakamura145