dealervault_api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c95b970d0fef58c23399f10fff6a92442af5b96aea9a0d1b51aacc722eb8b5
-  data.tar.gz: 8035befbeca89a0f7311930e6eaac71cfe9c687420d650a306a0047068df068f
+  metadata.gz: 8cba4e6b9ec3bfd80ed8bcbb5d3eeafc28d74a75e1f9cc75b7830e800becd69a
+  data.tar.gz: 8a461038e8d272a00885cecd021d7ee26d69a58ee172dbf3aa80f6eebecd3703
 SHA512:
-  metadata.gz: 3e347699a791412d5c7e5ee262cfc9d10066b782ef426f005a85d2aedbc5c7cfb8683c473ef883b9eec77a578b18b34a2161e76b48eaeb4194a44beb19b82fd1
-  data.tar.gz: 1a0eae5bbeefed6c8786f80a72e45cd72ad0520496d22a287b056d285d86a7026634831bcad7253308a27e264a0f6d53dc1cf104e8a7d911cfe32c6da34d7d48
+  metadata.gz: 5bfc175dee99d296973a043266e1958ebfe3bb1b0463c9ed368e5362b4af832c9ea37fa2ad69564ccab79ab9e8115f2ef1cb47338320b1b19fcc779420d87edd
+  data.tar.gz: 9400ad920880c1efe5cf148398452dd5d395b113ba794dce7aa84b39ab9e1ef7b28d8fae99a32adb262660c3f276f9bdeac06dbc180cb4d58ef3e6ee70832536

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.] - 2021-08-16
+
+- Added all the other endpoints including creating delivery
+- Updated specs
+
 ## [0.1.1] - 2021-08-03
 
 - Added the get JWT token endpoint

data/README.md

@@ -12,21 +12,37 @@ gem 'dealervault_api'
 
 And then execute:
 
-    $ bundle install
+```shell
+$ bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install dealervault_api
+```shell
+$ gem install dealervault_api
+```
 
 ## Usage
 
 Initialize client
     
-    client = DealervaultApi::Client.new('USER_EMAIL_HERE', 'API_KEY_HERE')
+```ruby
+client = DealervaultApi::Client.new('USER_EMAIL_HERE', 'API_KEY_HERE') # the token will be retrieved
+```
+
+Create a delivery request and retrieve id
+```ruby
+data = @client.delivery.create('PROGRAM_ID_DVV12345', 'ROOFTOP_ID_DVD12345', 'FILE_TYPE', 'TYPE')
+data['requestId']
+```
+
+Check the data set
+
+```ruby 
+data = @client.delivery.data_set('REQUEST_ID', 500)
+```
+
 
-GET JWT TOKEN
-    
-    response = client.delivery.get_jwt_token
 
 ## 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.

data/lib/dealervault_api/api/delivery.rb

@@ -2,14 +2,81 @@ module DealervaultApi
   class Delivery
     attr_accessor :api_client
 
+    VALID_PARAMETERS = {
+      feeds: [:fileTypeCode, :compareDate],
+      create: [:type, :historicalMonths, :catchupStartDate, :catchupEndDate]
+    }
+
+    VALID_VALUES = {
+      feeds: {
+        fileTypeCode: %w[SL]
+      },
+      create: {
+        type: %w[Sample Daily Historical Catchup],
+        historicalMonths: true,
+        catchupStartDate: true,
+        catchupEndDate: true
+      }
+    }
+
     def initialize(api_client)
       @api_client = api_client
+      @jwt = self.jwt_token
     end
 
-    # get jwt token
-    def get_jwt_token
+    # GET - Acquires a JWT token for authentication. Token will be valid for 30 minutes.
+    def jwt_token
       local_var_path = 'token'
-      @api_client.call_api(:GET, local_var_path)
+      body = @api_client.call_api(:GET, local_var_path)
+      body['token']
+    end
+
+    # GET - Gets information about a delivery.
+    def information(request_id)
+      local_var_path = "delivery/#{request_id}"
+      @api_client.call_api(:GET, local_var_path, headers: {'X-Jwt-Token' => @jwt})
+    end
+
+    # GET - Retrieve feeds which DealerVault received updated data since the provided compare date.
+    def feeds(program_id, compare_date, file_type_code='SL',params={} )
+      local_var_path = "vendor/#{program_id}/feeds/updated-data"
+      if compare_date.class == DateTime
+        compare_date = compare_date.to_time
+      end
+
+      params.merge!({fileTypeCode: file_type_code, compareDate: compare_date.utc.strftime("%FT%T%:z")})
+      params = whitelist_params(params, VALID_PARAMETERS, :feeds)
+      @api_client.call_api(:GET, local_var_path, headers: {'X-Jwt-Token' => @jwt}, query_params: params)
+    end
+
+    # GET - Retrieves a paged data set.
+    def data_set(request_id, page_size, params={})
+      local_var_path = "delivery"
+      params.merge!({requestId: request_id, pageSize: page_size})
+      @api_client.call_api(:GET, local_var_path, headers: {'X-Jwt-Token' => @jwt}, query_params: params)
+    end
+
+    # POST - Initiate a dealer delivery
+    def create(program_id, rooftop_id, file_type, delivery_type, options={})
+      local_var_path = "delivery"
+      options.merge!({type: delivery_type})
+      options = whitelist_params(options, VALID_PARAMETERS, :create)
+
+      body = {
+        programId: program_id,
+        rooftopId: rooftop_id,
+        fileType: file_type,
+        options: options
+      }
+
+      body = @api_client.call_api(:POST, local_var_path, headers: {'X-Jwt-Token' => @jwt}, body: body)
+      body
+    end
+
+
+
+    def whitelist_params(params, valid_params, key)
+      params.slice(*valid_params[key])
     end
   end
 end

data/lib/dealervault_api/api_client.rb

@@ -17,7 +17,10 @@ module DealervaultApi
     end
 
     def call_api(http_method, path, opts = {})
-      headers = {'Content-Type' => "application/json", 'X-User': @user, 'Ocp-Apim-Subscription-Key': @subscription_key}
+      headers = {'X-User' => @user, 'Content-Type' => "application/json", 'Ocp-Apim-Subscription-Key': @subscription_key}
+      if opts[:headers]
+        headers.merge!(opts[:headers])
+      end
 
       conn = Faraday.new(
         url: @host,
@@ -29,7 +32,7 @@ module DealervaultApi
       res = nil
       case http_method.to_sym.downcase
       when :post, :put, :patch, :delete
-        res = conn.run_request(http_method.to_sym.downcase, path,  opts[:body], nil)
+        res = conn.run_request(http_method.to_sym.downcase, path,  opts[:body].to_json, nil)
       when :get
         res = conn.run_request(:get, path,  nil, nil)
 

data/lib/dealervault_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DealervaultApi
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dealervault_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - marcus.salinas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday