accessgrid 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15b5d0cfdff13339d74d78a8204778a5eb0d36df704b6e2b67899dc4d9799d82
-  data.tar.gz: c2429ef868beb9ce1e45d2535451ee8c1909bafbd446555d04be72c989ba2770
+  metadata.gz: ab77e5bbf4a0a163fb5990dd7a0c6872c31bdbeb750bd7906b394d0d86e70d59
+  data.tar.gz: 2e6dff141d2eb8bd4c605c5363b12d0494e587cd4bcd1dc7e8a856d745dfa4ef
 SHA512:
-  metadata.gz: c43a8a49895d402425966639e9b43f66daa745d29f8c26f00429cc42b364a4e6835c3c9277ddd675743bfa223d2b34848edcf666cd37aa1a2e6b4383088c2918
-  data.tar.gz: 9d3de9854fd135763cb15035655abac79078ef709d257cab99e8850f1a23821aa08004b80a47d94abfd78b90467af353b560b2a266bc0aa6cf940e088d9f587b
+  metadata.gz: 2516e380d23a8b0e0bc988c5fb47c322707c0f2b98e5d82f1df4cfb500353bb56b131347e4bb9f899aa853d93d3acd6512edabe70f8c06b35d7a893804b3b1cb
+  data.tar.gz: 94cd560394836b1be4b73541557715867dc3f92979563778448c93e26994a3ea93d2681a6704d01f1c585b7d5ffa8b8380a00efb2a25913cdb7a42da90ed5415

data/README.md

@@ -37,14 +37,14 @@ client = AccessGrid.new(account_id, secret_key)
 
 ### Access Cards
 
-#### Provision a new card
+#### Issue a new card
 
 ```ruby
-card = client.access_cards.provision(
-  card_template_id: "0xd3adb00b5",
+card = client.access_cards.issue(
+  card_template_id: card_template_id,
   employee_id: "123456789",
+  card_number: "16187",
   tag_id: "DDEADB33FB00B5",
-  allow_on_multiple_devices: true,
   full_name: "Employee name",
   email: "employee@yourwebsite.com",
   phone_number: "+19547212241",
@@ -54,39 +54,71 @@ card = client.access_cards.provision(
   employee_photo: "[image_in_base64_encoded_format]"
 )
 
+# Provision is an alias for issue (for backwards compatibility)
+card = client.access_cards.provision(
+  card_template_id: card_template_id,
+  employee_id: "123456789",
+  # ...other parameters
+)
+
 puts "Install URL: #{card.url}"
 ```
 
+#### Get a card
+
+```ruby
+card = client.access_cards.get(card_id: "0xc4rd1d")
+
+puts "Card ID: #{card.id}"
+puts "State: #{card.state}"
+puts "Full Name: #{card.full_name}"
+puts "Install URL: #{card.install_url}"
+puts "Expiration Date: #{card.expiration_date}"
+puts "Card Number: #{card.card_number}"
+puts "Site Code: #{card.site_code}"
+puts "Devices: #{card.devices.length}"
+puts "Metadata: #{card.metadata}"
+```
+
 #### Update a card
 
 ```ruby
 card = client.access_cards.update(
-  card_id: "0xc4rd1d",
-  employee_id: "987654321",
-  full_name: "Updated Employee Name",
-  classification: "contractor",
-  expiration_date: "2025-02-22T21:04:03.664Z",
-  employee_photo: "[image_in_base64_encoded_format]"
+  "0xc4rd1d", 
+  {
+    employee_id: "987654321",
+    full_name: "Updated Employee Name",
+    classification: "contractor",
+    expiration_date: "2025-02-22T21:04:03.664Z",
+    employee_photo: "[image_in_base64_encoded_format]"
+  }
 )
 ```
 
+#### List cards
+
+```ruby
+# List all cards for a template
+cards = client.access_cards.list("template_id")
+
+# List cards filtered by state
+active_cards = client.access_cards.list("template_id", "active")
+```
+
 #### Manage card states
 
 ```ruby
 # Suspend a card
-client.access_cards.suspend(
-  card_id: "0xc4rd1d"
-)
+client.access_cards.suspend("0xc4rd1d")
 
 # Resume a card
-client.access_cards.resume(
-  card_id: "0xc4rd1d"
-)
+client.access_cards.resume("0xc4rd1d")
 
 # Unlink a card
-client.access_cards.unlink(
-  card_id: "0xc4rd1d"
-)
+client.access_cards.unlink("0xc4rd1d")
+
+# Delete a card
+client.access_cards.delete("0xc4rd1d")
 ```
 
 ### Enterprise Console
@@ -124,17 +156,19 @@ template = client.console.create_template(
 
 ```ruby
 template = client.console.update_template(
-  card_template_id: "0xd3adb00b5",
-  name: "Updated Employee NFC key",
-  allow_on_multiple_devices: true,
-  watch_count: 2,
-  iphone_count: 3,
-  support_info: {
-    support_url: "https://help.yourcompany.com",
-    support_phone_number: "+1-555-123-4567",
-    support_email: "support@yourcompany.com",
-    privacy_policy_url: "https://yourcompany.com/privacy",
-    terms_and_conditions_url: "https://yourcompany.com/terms"
+  "0xd3adb00b5",
+  {
+    name: "Updated Employee NFC key",
+    allow_on_multiple_devices: true,
+    watch_count: 2,
+    iphone_count: 3,
+    support_info: {
+      support_url: "https://help.yourcompany.com",
+      support_phone_number: "+1-555-123-4567",
+      support_email: "support@yourcompany.com",
+      privacy_policy_url: "https://yourcompany.com/privacy",
+      terms_and_conditions_url: "https://yourcompany.com/terms"
+    }
   }
 )
 ```
@@ -142,14 +176,24 @@ template = client.console.update_template(
 #### Read a template
 
 ```ruby
-template = client.console.read_template(
-  card_template_id: "0xd3adb00b5"
-)
+template = client.console.read_template("0xd3adb00b5")
 ```
 
 #### Get event logs
 
 ```ruby
+# New method
+logs = client.console.get_logs(
+  "0xd3adb00b5",
+  {
+    device: "mobile", # "mobile" or "watch"
+    start_date: (Time.now - 30*24*60*60).iso8601,
+    end_date: Time.now.iso8601,
+    event_type: "install"
+  }
+)
+
+# Legacy method still works
 events = client.console.event_log(
   card_template_id: "0xd3adb00b5",
   filters: {
@@ -179,6 +223,7 @@ The SDK throws specific errors for various scenarios:
 - `AccessGrid::AuthenticationError` - Invalid credentials
 - `AccessGrid::ResourceNotFoundError` - Requested resource not found
 - `AccessGrid::ValidationError` - Invalid parameters
+- `AccessGrid::AccessGridError` - Base exception for AccessGrid-specific errors
 - `AccessGrid::Error` - Generic API errors
 
 Example error handling:

data/lib/accessgrid/access_cards.rb

@@ -5,17 +5,32 @@ module AccessGrid
       @client = client
     end
 
-    def provision(params)
+    def issue(params)
       response = @client.make_request(:post, '/v1/key-cards', params)
       Card.new(response)
     end
+    
+    # Alias provision to issue for backward compatibility
+    alias provision issue
 
-    def update(params)
-      card_id = params.delete(:card_id)
-      response = @client.make_request(:put, "/v1/key-cards/#{card_id}", params)
+    def get(card_id:)
+      response = @client.make_request(:get, "/v1/key-cards/#{card_id}")
       Card.new(response)
     end
 
+    def update(card_id, params)
+      response = @client.make_request(:patch, "/v1/key-cards/#{card_id}", params)
+      Card.new(response)
+    end
+    
+    def list(template_id, state = nil)
+      params = { template_id: template_id }
+      params[:state] = state if state
+      
+      response = @client.make_request(:get, '/v1/key-cards', nil, params)
+      response.fetch('keys', []).map { |item| Card.new(item) }
+    end
+
     private def manage_state(card_id, action)
       response = @client.make_request(
         :post, 
@@ -25,28 +40,50 @@ module AccessGrid
       Card.new(response)
     end
 
-    def suspend(params)
-      manage_state(params[:card_id], 'suspend')
+    def suspend(card_id)
+      manage_state(card_id, 'suspend')
     end
 
-    def resume(params)
-      manage_state(params[:card_id], 'resume')
+    def resume(card_id)
+      manage_state(card_id, 'resume')
     end
 
-    def unlink(params)
-      manage_state(params[:card_id], 'unlink')
+    def unlink(card_id)
+      manage_state(card_id, 'unlink')
+    end
+    
+    def delete(card_id)
+      manage_state(card_id, 'delete')
     end
   end
 
   class Card
-    attr_reader :id, :state, :url, :full_name, :expiration_date
+    attr_reader :id, :state, :url, :install_url, :details, :full_name,
+                :expiration_date, :card_template_id, :card_number, :site_code,
+                :file_data, :direct_install_url, :devices, :metadata
 
     def initialize(data)
-      @id = data['id']
-      @state = data['state']
-      @url = data['install_url']
-      @full_name = data['full_name']
-      @expiration_date = data['expiration_date']
+      data ||= {}
+      @id = data.fetch('id', nil)
+      @state = data.fetch('state', nil)
+      @url = data.fetch('install_url', nil)
+      @install_url = data.fetch('install_url', nil)
+      @details = data.fetch('details', nil)
+      @full_name = data.fetch('full_name', nil)
+      @expiration_date = data.fetch('expiration_date', nil)
+      @card_template_id = data.fetch('card_template_id', nil)
+      @card_number = data.fetch('card_number', nil)
+      @site_code = data.fetch('site_code', nil)
+      @file_data = data.fetch('file_data', nil)
+      @direct_install_url = data.fetch('direct_install_url', nil)
+      @devices = data.fetch('devices', [])
+      @metadata = data.fetch('metadata', {})
+    end
+
+    def to_s
+      "Card(name='#{@full_name}', id='#{@id}', state='#{@state}')"
     end
+
+    alias inspect to_s
   end
 end

data/lib/accessgrid/console.rb

@@ -11,22 +11,33 @@ module AccessGrid
       Template.new(response)
     end
 
-    def update_template(params)
-      card_template_id = params.delete(:card_template_id)
+    def update_template(template_id, params)
       transformed_params = transform_template_params(params)
-      response = @client.make_request(:put, "/v1/console/card-templates/#{card_template_id}", transformed_params)
+      response = @client.make_request(:put, "/v1/console/card-templates/#{template_id}", transformed_params)
       Template.new(response)
     end
 
-    def read_template(params)
-      response = @client.make_request(:get, "/v1/console/card-templates/#{params[:card_template_id]}")
+    def read_template(template_id)
+      response = @client.make_request(:get, "/v1/console/card-templates/#{template_id}")
       Template.new(response)
     end
 
+    def get_logs(template_id, params = {})
+      response = @client.make_request(:get, "/v1/console/card-templates/#{template_id}/logs", nil, params)
+      
+      # Return full response to match Python's behavior
+      if response['logs']
+        response['logs'] = response['logs'].map { |log| Event.new(log) }
+      end
+      
+      response
+    end
+    
+    # Keep event_log for backwards compatibility
     def event_log(params)
-      card_template_id = params.delete(:card_template_id)
-      response = @client.make_request(:get, "/v1/console/card-templates/#{card_template_id}/logs", params)
-      response['logs'].map { |log| Event.new(log) }
+      template_id = params.delete(:card_template_id)
+      response = get_logs(template_id, params)
+      response['logs'] || []
     end
 
     private
@@ -49,18 +60,23 @@ module AccessGrid
   end
 
   class Template
-    attr_reader :id, :name, :platform, :protocol, :allow_on_multiple_devices,
-                :watch_count, :iphone_count, :support_info, :style_settings
+    attr_reader :id, :name, :platform, :protocol, :use_case, :created_at, 
+                :last_published_at, :issued_keys_count, :active_keys_count,
+                :allowed_device_counts, :support_settings, :terms_settings, :style_settings
 
     def initialize(data)
       @id = data['id']
       @name = data['name']
       @platform = data['platform']
       @protocol = data['protocol']
-      @allow_on_multiple_devices = data['allowed_device_counts']['allow_on_multiple_devices']
-      @watch_count = data['allowed_device_counts']['watch']
-      @iphone_count = data['allowed_device_counts']['iphone']
-      @support_info = data['support_settings']
+      @use_case = data['use_case']
+      @created_at = data['created_at']
+      @last_published_at = data['last_published_at']
+      @issued_keys_count = data['issued_keys_count']
+      @active_keys_count = data['active_keys_count']
+      @allowed_device_counts = data['allowed_device_counts']
+      @support_settings = data['support_settings']
+      @terms_settings = data['terms_settings']
       @style_settings = data['style_settings']
     end
   end
@@ -71,7 +87,7 @@ module AccessGrid
     def initialize(data)
       @type = data['event']
       @timestamp = data['created_at']
-      @user_id = data['metadata']['user_id']
+      @user_id = data['metadata']['user_id'] if data['metadata'] && data['metadata']['user_id']
       @ip_address = data['ip_address']
       @user_agent = data['user_agent']
       @metadata = data['metadata']

data/lib/accessgrid/version.rb

@@ -1,4 +1,4 @@
 # lib/accessgrid/version.rb
 module AccessGrid
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/accessgrid.rb

@@ -15,13 +15,24 @@ module AccessGrid
   class ResourceNotFoundError < Error; end
   class ValidationError < Error; end
   
+  # Additional error classes to match Python version
+  class AccessGridError < Error; end
+  
   class Client
     attr_reader :account_id, :api_secret, :api_host
     
     def initialize(account_id, api_secret, api_host = 'https://api.accessgrid.com')
+      if account_id.nil? || account_id.empty?
+        raise ArgumentError, "Account ID is required"
+      end
+      
+      if api_secret.nil? || api_secret.empty?
+        raise ArgumentError, "API Secret is required"
+      end
+      
       @account_id = account_id
       @api_secret = api_secret
-      @api_host = api_host
+      @api_host = api_host.chomp('/')
     end
 
     def access_cards
@@ -32,8 +43,14 @@ module AccessGrid
       @console ||= Console.new(self)
     end
 
-    def make_request(method, path, body = nil)
+    def make_request(method, path, body = nil, params = nil)
       uri = URI.parse("#{api_host}#{path}")
+      
+      # Add query parameters if present
+      if params && !params.empty?
+        uri.query = URI.encode_www_form(params)
+      end
+      
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme == 'https'
 
@@ -45,6 +62,8 @@ module AccessGrid
         Net::HTTP::Post.new(uri.request_uri)
       when :put
         Net::HTTP::Put.new(uri.request_uri)
+      when :patch
+        Net::HTTP::Patch.new(uri.request_uri)
       else
         raise ArgumentError, "Unsupported HTTP method: #{method}"
       end
@@ -52,12 +71,56 @@ module AccessGrid
       # Set headers
       request['Content-Type'] = 'application/json'
       request['X-ACCT-ID'] = account_id
+      request['User-Agent'] = "accessgrid.rb @ v#{AccessGrid::VERSION}"
+      
+      # Extract resource ID from the path if needed for signature
+      resource_id = nil
+      if method == :get || (method == :post && (body.nil? || body.empty?))
+        parts = path.strip.split('/')
+        if parts.length >= 2
+          if ['suspend', 'resume', 'unlink', 'delete'].include?(parts.last)
+            resource_id = parts[-2]
+          else
+            resource_id = parts.last
+          end
+        end
+      end
+      
+      # Handle signature generation
+      if method == :get || (method == :post && (body.nil? || body.empty?))
+        payload = resource_id ? { id: resource_id }.to_json : '{}'
+        
+        # Include sig_payload in query params if needed
+        if resource_id
+          if params.nil?
+            params = {}
+          end
+          params[:sig_payload] = { id: resource_id }.to_json
+          
+          # Update the URI with the new params
+          uri.query = URI.encode_www_form(params)
+          request = case method
+          when :get
+            Net::HTTP::Get.new(uri.request_uri)
+          when :post
+            Net::HTTP::Post.new(uri.request_uri)
+          end
+          
+          # Reset headers after creating new request
+          request['Content-Type'] = 'application/json'
+          request['X-ACCT-ID'] = account_id
+          request['User-Agent'] = "accessgrid.rb @ v#{AccessGrid::VERSION}"
+        end
+      else
+        payload = body ? body.to_json : ""
+      end
+      
+      # Generate signature
+      request['X-PAYLOAD-SIG'] = generate_signature(payload)
       
-      # Generate signature if body present
-      if body
-        json_body = body.to_json
-        request['X-PAYLOAD-SIG'] = generate_signature(json_body)
-        request.body = json_body
+      # Add the body to the request
+      if body && method != :get
+        request.body = body.to_json
       end
 
       # Make request
@@ -71,7 +134,7 @@ module AccessGrid
 
     def generate_signature(payload)
       # Base64 encode the payload
-      encoded_payload = Base64.strict_encode64(payload)
+      encoded_payload = Base64.strict_encode64(payload.to_s)
       
       # Generate SHA256 hash
       OpenSSL::HMAC.hexdigest(
@@ -87,12 +150,21 @@ module AccessGrid
         JSON.parse(response.body)
       when 401
         raise AuthenticationError, 'Invalid credentials'
+      when 402
+        raise Error, 'Insufficient account balance'
       when 404
         raise ResourceNotFoundError, 'Resource not found'
       when 422
         raise ValidationError, JSON.parse(response.body)['message']
       else
-        raise Error, "API request failed with status #{response.code}: #{response.body}"
+        error_message = response.body.empty? ? "HTTP Status #{response.code}" : response.body
+        begin
+          error_data = JSON.parse(response.body)
+          error_message = error_data['message'] if error_data['message']
+        rescue JSON::ParserError
+          # If it's not valid JSON, just use the response body
+        end
+        raise Error, "API request failed: #{error_message}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: accessgrid
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Auston Bunsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-01 00:00:00.000000000 Z
+date: 2025-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler