sg 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82732360828cab23d974a31339ae0cf92559c1f9
-  data.tar.gz: fccc5163a71d88252763e51c16f770a39a30a773
+  metadata.gz: 58c69276b3aa823085cd154fd690173f59a7e0cd
+  data.tar.gz: c0c632215de867766f0155e82e1a4d3d49a4e9c5
 SHA512:
-  metadata.gz: 450aba729809d6546a76afd56e5a355509bc3b8ff8b541c224f78f19a91a777a6dadd6b16de17597eab272ddf24a4fb4bed4d07efdb8f2f6f5b565a0f96a9e69
-  data.tar.gz: 405610df86a8885d0d505b8614f2819f6959bd6bb9419cc8b6485ecb1f521502c0eb092fd05484058eefc062f6aa6d4174bf8ffe41422e5f19deb0eda2be6a86
+  metadata.gz: 640cd7e37314d6e18ffa11400aed59756f86c489983ffc44e2dc7964decfb5c34064b19e92504f21d0b674f19316729ae4b485907a0e94503dfb2fb1659518fa
+  data.tar.gz: 0269800f26f161a94d61bc0c0a7b5da56a70270f85c9f504ab7dcfac8a80cf9afcf13d329e99e56c6779c9c4e9d4dd5cb5b1e8986688746a231a82ce871e73c6

data/README.md

@@ -23,6 +23,41 @@ See help.
 
     $ bundle exec sg client help
 
+### Example
+
+1.
+
+    GET https://api.sendgrid.com/v3/api_keys HTTP/1.1
+
+should be:
+
+    $ bundle exec sg client api_keys get
+
+2.
+
+    GET https://api.sendgrid.com/v3/api_keys/YOUR_API_KEY_ID HTTP/1.1
+
+should be:
+
+    $ bundle exec sg client api_keys YOUR_API_KEY_ID get
+
+3.
+
+    GET https://api.sendgrid.com/v3/suppression/bounces?start_time=14324566&end_time=14324566 HTTP/1.1
+
+should be:
+
+    $ bundle exec sg client suppression bounces get -q='{"start_time": 14324566, "end_time": 14324566}'
+
+4.
+
+    POST https://api.sendgrid.com/v3/api_keys HTTP/1.1
+    {"name": "My API Key", "scopes": ["mail.send"]}
+
+should be:
+
+    $ bundle exec sg client api_keys post -b='{"name": "My API Key", "scopes": ["mail.send"]}'
+
 ## 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. Run `bundle exec sg` to use the gem in this directory, ignoring other installed copies of this gem.

data/lib/sg/version.rb

@@ -2,5 +2,5 @@
 # SendGrid Command Line Interface
 #
 module Sg
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/sg.rb

@@ -7,7 +7,34 @@ module Sg
   # SendGrid Command Line Interface Class
   #
   class CLI < Thor
-    desc 'client', 'Call SendGrid Web API v3 from command line interface'
+    desc(
+      'client *PATH_TO_THE_ENDPOINT VERB',
+      'Call SendGrid Web API v3 from command line interface'
+    )
+    long_desc <<-DESC
+      1. Simple GET call
+      \x5Use the client command with path after v3 level with space.
+      Then add the HTTP verb at the end of the command.
+      \x5GET https://api.sendgrid.com/v3/api_keys
+      \x5> $ bundle exec sg client api_keys get
+
+      2. With variable
+      \x5Use the client command with the variable values.
+      Then add the HTTP verb at the end of the command.
+      \x5GET https://api.sendgrid.com/v3/api_keys/YOUR_API_KEY_ID
+      \x5> $ bundle exec sg client api_keys YOUR_API_KEY_ID get
+
+      3. With query string
+      \x5Use -q option for the query string with the JSON string value.
+      \x5GET https://api.sendgrid.com/v3/suppression/bounces?start_time=14324566&end_time=14324566
+      \x5> $ bundle exec sg client suppression bounces get -q='{"start_time": 14324566, "end_time": 14324566}'
+
+      4. With request body
+      \x5Use -b option for the request body with the JSON string value.
+      \x5POST https://api.sendgrid.com/v3/api_keys
+      \x5{"name": "My API Key", "scopes": ["mail.send"]}
+      \x5> $ bundle exec sg client api_keys post -b='{"name": "My API Key", "scopes": ["mail.send"]}'
+    DESC
     option(
       :apikey,
       aliases: '-k',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - awwa500@gmail.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -143,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Call SendGrid API v3 from the command line interface.