supersaas-api-client 0.10.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eab1cbc42e58b7936550c6881205c8869f75631b2e0f7f5e45bb7a06a721f7b
-  data.tar.gz: 72d8368d4e60895872bf2d7ebe8b4b45a887626cd0c01abbbb6817c469d7cfcf
+  metadata.gz: 4cd91008c369ed81daba9f3b18bf00e4d05ec9dd0e9251a1b3784b2a2c733c2e
+  data.tar.gz: 2f6140acf5eafe80cd6a393c9e1213c23702589fd9e83a1b0e715aca9ae16398
 SHA512:
-  metadata.gz: ae1672d2a6e704a401170f0b34022c441448cb092920ecce186f27eff0cf8dd04abe884cd4009fa93e421ada49a7f1f4697f0c41732920f92103bf5e2698710d
-  data.tar.gz: 9f0e4efd6c65482a762d18e7fe1adc3215456f965bf7fca80b503834a54a37d3aa658d81966bbd0ad8dbb54af2198ec94883ff2fa8d5b97e2c6e3d0b7052a25b
+  metadata.gz: d3fd7377e8aca4df5bd47ea3dc26211fd4eecc2c2406cfb55c4d914804b589c899ad5f0d2d8764f70de36f1a9d3646a9839219d9ae688bfa40dff905652dd793
+  data.tar.gz: 0ae95b465f2b6c48c07e9125be5a740483b268e23e9262805d3b63fd8971c6f4fd546128cc276fdae1e94549b2b15840f44018abb17c35e7257da3e3a29e75cb

data/README.md

@@ -7,7 +7,7 @@ The SuperSaaS API provides services that can be used to add online booking and s
 ## Prerequisites
 
 1. [Register for a (free) SuperSaaS account](https://www.supersaas.com/accounts/new), and
-2. get your account name and password.
+2. get your account name and API key on the [Account Info](https://www.supersaas.com/accounts/edit) page.
 
 ##### Dependencies
 
@@ -43,21 +43,21 @@ Initialize the SuperSaaS `Client` with authorization credentials:
 
     Supersaas::Client.configure do |config|
       config.account_name = 'accnt'
-      config.password = 'pwd'
+      config.api_key = 'xxxxxxxxxxxxxxxxxxxxxx'
     end
     
 > Note, ensure that `configure` is called before `instance` or `new`, otherwise the client will be initialized with configuration defaults.
 
-If the client isn't configured explicitly, it will use default `ENV` variables for the account name and password.
+If the client isn't configured explicitly, it will use default `ENV` variables for the account name and api key.
 
     ENV['SSS_API_ACCOUNT_NAME'] = 'your-env-supersaas-account-name'
-    ENV['SSS_API_PASSWORD'] = 'your-env-supersaas-account-name' 
+    ENV['SSS_API_KEY'] = 'your-env-supersaas-account-name' 
     Supersaas::Client.instance.account_name #=> 'your-env-supersaas-account-name'
-    Supersaas::Client.instance.password #=> 'your-env-supersaas-account-name'
+    Supersaas::Client.instance.api_key #=> 'your-env-supersaas-account-name'
     
 All configuration options can be individually set on the client.
 
-    Supersaas::Client.instance.password = 'pwd' 
+    Supersaas::Client.instance.api_key = 'xxxxxxxxxxxxxxxxxxxxxx' 
     Supersaas::Client.instance.verbose = true
     ...
 
@@ -189,12 +189,12 @@ Get a single form by `form_id`:
 
 The ./examples folder contains several executable Ruby scripts demonstrating how to use the API Client for common requests.
 
-The examples will require your account name, password, and some of the examples a schedule id and/or user id and/or form id. These can be set as environment variables. e.g.
+The examples will require your account name, api key, and some of the examples a schedule id and/or user id and/or form id. These can be set as environment variables. e.g.
 
     $ gem install supersaas-api-client
-    $ SSS_API_UID=myuserid SSS_API_SCHEDULE=myscheduleid SSS_API_ACCOUNT_NAME=myaccountname SSS_API_PASSWORD=mypassword ./examples/appointments.rb
-    $ SSS_API_FORM=myuserid SSS_API_ACCOUNT_NAME=myaccountname SSS_API_PASSWORD=mypassword ./examples/forms.rb 
-    $ SSS_API_ACCOUNT_NAME=myaccountname SSS_API_PASSWORD=mypassword ./examples/users.rb
+    $ SSS_API_UID=myuserid SSS_API_SCHEDULE=myscheduleid SSS_API_ACCOUNT_NAME=myaccountname SSS_API_KEY=xxxxxxxxxxxxxxxxxxxxxx ./examples/appointments.rb
+    $ SSS_API_FORM=myuserid SSS_API_ACCOUNT_NAME=myaccountname SSS_API_KEY=xxxxxxxxxxxxxxxxxxxxxx ./examples/forms.rb 
+    $ SSS_API_ACCOUNT_NAME=myaccountname SSS_API_KEY=xxxxxxxxxxxxxxxxxxxxxx ./examples/users.rb
 
 ## Testing
 

data/examples/appointments.rb

@@ -6,14 +6,14 @@ require "supersaas-api-client"
 
 puts "\n\r# SuperSaaS Appointments Example\n\r"
 
-unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.password
+unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
   puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g.\n\r"
-  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_PASSWORD=<mypassword> ./examples/appointments.rb\n\r"
+  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<api_key> ./examples/appointments.rb\n\r"
   return
 end
 
 puts "## Account:  #{Supersaas::Client.instance.account_name}"
-puts "## Password: #{'*' * Supersaas::Client.instance.password.size}\n\r"
+puts "## API Key: #{'*' * Supersaas::Client.instance.api_key.size}\n\r"
 
 Supersaas::Client.instance.verbose = true
 

data/examples/forms.rb

@@ -5,14 +5,14 @@ require "supersaas-api-client"
 
 puts "\n\r# SuperSaaS Forms Example\n\r"
 
-unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.password
+unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
   puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g.\n\r"
-  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_PASSWORD=<mypassword> ./examples/appointments.rb\n\r"
+  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/appointments.rb\n\r"
   return
 end
 
 puts "## Account:  #{Supersaas::Client.instance.account_name}"
-puts "## Password: #{'*' * Supersaas::Client.instance.password.size}\n\r"
+puts "## API Key: #{'*' * Supersaas::Client.instance.api_key.size}\n\r"
 
 Supersaas::Client.instance.verbose = true
 

data/examples/schedules.rb

@@ -4,14 +4,14 @@ require "supersaas-api-client"
 
 puts "\n\r# SuperSaaS Schedules Example\n\r"
 
-unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.password
+unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
   puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g.\n\r"
-  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_PASSWORD=<mypassword> ./examples/users.rb\n\r"
+  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb\n\r"
   return
 end
 
 puts "## Account:  #{Supersaas::Client.instance.account_name}"
-puts "## Password: #{'*' * Supersaas::Client.instance.password.size}\n\r"
+puts "## API KEY: #{'*' * Supersaas::Client.instance.api_key.size}\n\r"
 
 Supersaas::Client.instance.verbose = true
 

data/examples/users.rb

@@ -4,20 +4,20 @@ require "supersaas-api-client"
 
 puts "\n\r# SuperSaaS Users Example\n\r"
 
-unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.password
+unless Supersaas::Client.instance.account_name && Supersaas::Client.instance.api_key
   puts "ERROR! Missing account credentials. Rerun the script with your credentials, e.g.\n\r"
-  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_PASSWORD=<mypassword> ./examples/users.rb\n\r"
+  puts "    SSS_API_ACCOUNT_NAME=<myaccountname> SSS_API_KEY=<xxxxxxxxxxxxxxxxxxxxxx> ./examples/users.rb\n\r"
   return
 end
 
 puts "## Account:  #{Supersaas::Client.instance.account_name}"
-puts "## Password: #{'*' * Supersaas::Client.instance.password.size}\n\r"
+puts "## API Key: #{'*' * Supersaas::Client.instance.api_key.size}\n\r"
 
 Supersaas::Client.instance.verbose = true
 
 puts "creating new user..."
 puts "\n\r#### Supersaas::Client.instance.users.create({...})\n\r"
-params = {full_name: 'Example', name: 'example@example.com', email: 'example@example.com', password: 'example'}
+params = {full_name: 'Example', name: 'example@example.com', email: 'example@example.com', api_key: 'example'}
 Supersaas::Client.instance.users.create(params)
 new_user_id = nil
 

data/lib/supersaas-api-client/client.rb

@@ -21,13 +21,13 @@ module Supersaas
       end
     end
 
-    attr_accessor :account_name, :password, :host, :dry_run, :verbose
+    attr_accessor :account_name, :api_key, :host, :dry_run, :verbose
     attr_reader :last_request
 
     def initialize(configuration=nil)
       configuration = configuration || Configuration.new
       @account_name = configuration.account_name
-      @password = configuration.password
+      @api_key = configuration.api_key
       @host = configuration.host
       @dry_run = configuration.dry_run
       @verbose = configuration.verbose
@@ -58,7 +58,7 @@ module Supersaas
 
     def request(http_method, path, params={}, query={})
       raise Supersaas::Exception.new("Account name not configured. Call `Supersaas::Client.configure`.") unless account_name && account_name.size
-      raise Supersaas::Exception.new("Account password not configured. Call `Supersaas::Client.configure`.") unless password && password.size
+      raise Supersaas::Exception.new("Account api key not configured. Call `Supersaas::Client.configure`.") unless api_key && api_key.size
 
       uri = URI.parse(host)
       http = Net::HTTP.new(uri.host, uri.port)
@@ -86,7 +86,7 @@ module Supersaas
         raise Supersaas::Exception.new("Invalid HTTP Method: #{http_method}. Only `:get`, `:post`, `:put`, `:delete` supported.")
       end
 
-      req.basic_auth account_name, password
+      req.basic_auth account_name, api_key
 
       req['Accept'] = 'application/json'
       req['Content-Type'] = 'application/json'
@@ -145,11 +145,11 @@ module Supersaas
     class Configuration
       DEFAULT_HOST = 'https://www.supersaas.com'
 
-      attr_accessor :account_name, :host, :password, :dry_run, :verbose
+      attr_accessor :account_name, :host, :api_key, :dry_run, :verbose
 
       def initialize
         @account_name = ENV['SSS_API_ACCOUNT_NAME']
-        @password = ENV['SSS_API_PASSWORD']
+        @api_key = ENV['SSS_API_KEY']
         @host = DEFAULT_HOST
         @dry_run = false
         @verbose = false

data/lib/supersaas-api-client/version.rb

@@ -1,4 +1,4 @@
 module Supersaas
-  API_VERSION  = '1'
-  VERSION = '0.10.0'
+  API_VERSION  = '2'
+  VERSION = '1.0.0'
 end

data/test/appointments_test.rb

@@ -5,7 +5,7 @@ module Supersaas
     def setup
       @client = Supersaas::Client.instance
       @client.account_name = 'accnt'
-      @client.password = 'pwd'
+      @client.api_key = 'xxxxxxxxxxxxxxxxxxxxxx'
       @client.dry_run = true
       @schedule_id = 12345
       @appointment_id = 67890

data/test/client_test.rb

@@ -17,7 +17,7 @@ module Supersaas
 
     def test_request_methods
       @client.account_name = 'Test'
-      @client.password = 'testing123'
+      @client.api_key = 'testing123'
       [:get,:put,:post,:delete].each do |method|
         refute_nil @client.send(method, '/test')
         assert_equal method.to_s.upcase, @client.last_request.method
@@ -31,13 +31,13 @@ module Supersaas
     def test_instance_configuration
       Supersaas::Client.configure do |config|
         config.account_name = 'account'
-        config.password = 'password'
+        config.api_key = 'api_key'
         config.host = 'http://test'
         config.dry_run = true
         config.verbose = true
       end
       assert_equal 'account', Supersaas::Client.configuration.account_name
-      assert_equal 'password', Supersaas::Client.configuration.password
+      assert_equal 'api_key', Supersaas::Client.configuration.api_key
       assert_equal 'http://test', Supersaas::Client.configuration.host
       assert_equal true, Supersaas::Client.configuration.dry_run
       assert_equal true, Supersaas::Client.configuration.verbose

data/test/test_helper.rb

@@ -15,7 +15,7 @@ class SupersaasTest < Minitest::Test
     if !defined? @client
       @client = Supersaas::Client.instance
       @client.account_name = 'accnt'
-      @client.password = 'pwd'
+      @client.api_key = 'xxxxxxxxxxxxxxxxxxxxxx'
       @client.dry_run = true
     end
     @client

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supersaas-api-client
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Travis Dunn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-05 00:00:00.000000000 Z
+date: 2019-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Online bookings/appointments/calendars using the SuperSaaS scheduling platform.