accessgrid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3978f3315ab2ae70fbc1739375fdca9b99e9940848d484d6f3c4c4384881bf2f
+  data.tar.gz: af94d249034b73242e95036f12465cabb4527f12f49e93b94d22638476ef487b
+SHA512:
+  metadata.gz: c6e0a303e6dc0cd163d33aea38273f6daed151f80b2e8fe9aab36c362b1e09e5adb59ada4e82a55831667d8bab3b7596b29cd1413cfc1305528784479fbd51a8
+  data.tar.gz: 4bd691713c59e1ce6018eed73eab9f1556be85d4d56616603bcd2732b94460fdc87a36e669cb0f114cb8fda25532f0911cfc8b562ca2561931c52d8e60643f59

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AccessGrid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,222 @@
+# AccessGrid SDK
+
+A Ruby SDK for interacting with the [AccessGrid.com](https://www.accessgrid.com) API. This SDK provides a simple interface for managing NFC key cards and enterprise templates. Full docs at https://www.accessgrid.com/docs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'accessgrid'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install accessgrid
+```
+
+## Quick Start
+
+```ruby
+require 'accessgrid'
+
+account_id = ENV['ACCOUNT_ID']
+secret_key = ENV['SECRET_KEY']
+
+client = AccessGrid.new(account_id, secret_key)
+```
+
+## API Reference
+
+### Access Cards
+
+#### Provision a new card
+
+```ruby
+card = client.access_cards.provision(
+  card_template_id: "0xd3adb00b5",
+  employee_id: "123456789",
+  tag_id: "DDEADB33FB00B5",
+  allow_on_multiple_devices: true,
+  full_name: "Employee name",
+  email: "employee@yourwebsite.com",
+  phone_number: "+19547212241",
+  classification: "full_time",
+  start_date: "2025-01-31T22:46:25.601Z",
+  expiration_date: "2025-04-30T22:46:25.601Z",
+  employee_photo: "[image_in_base64_encoded_format]"
+)
+
+puts "Install URL: #{card.url}"
+```
+
+#### 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]"
+)
+```
+
+#### Manage card states
+
+```ruby
+# Suspend a card
+client.access_cards.suspend(
+  card_id: "0xc4rd1d"
+)
+
+# Resume a card
+client.access_cards.resume(
+  card_id: "0xc4rd1d"
+)
+
+# Unlink a card
+client.access_cards.unlink(
+  card_id: "0xc4rd1d"
+)
+```
+
+### Enterprise Console
+
+#### Create a template
+
+```ruby
+template = client.console.create_template(
+  name: "Employee NFC key",
+  platform: "apple",
+  use_case: "employee_badge",
+  protocol: "desfire",
+  allow_on_multiple_devices: true,
+  watch_count: 2,
+  iphone_count: 3,
+  design: {
+    background_color: "#FFFFFF",
+    label_color: "#000000",
+    label_secondary_color: "#333333",
+    background_image: "[image_in_base64_encoded_format]",
+    logo_image: "[image_in_base64_encoded_format]",
+    icon_image: "[image_in_base64_encoded_format]"
+  },
+  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"
+  }
+)
+```
+
+#### Update a 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"
+  }
+)
+```
+
+#### Read a template
+
+```ruby
+template = client.console.read_template(
+  card_template_id: "0xd3adb00b5"
+)
+```
+
+#### Get event logs
+
+```ruby
+events = client.console.event_log(
+  card_template_id: "0xd3adb00b5",
+  filters: {
+    device: "mobile", # "mobile" or "watch"
+    start_date: (Time.now - 30*24*60*60).iso8601,
+    end_date: Time.now.iso8601,
+    event_type: "install"
+  }
+)
+```
+
+## Configuration
+
+The SDK can be configured with a custom API endpoint:
+
+```ruby
+client = AccessGrid.new(
+  account_id, 
+  secret_key, 
+  'https://api.staging.accessgrid.com' # Use a different API endpoint
+)
+```
+
+## Error Handling
+
+The SDK throws specific errors for various scenarios:
+- `AccessGrid::AuthenticationError` - Invalid credentials
+- `AccessGrid::ResourceNotFoundError` - Requested resource not found
+- `AccessGrid::ValidationError` - Invalid parameters
+- `AccessGrid::Error` - Generic API errors
+
+Example error handling:
+
+```ruby
+begin
+  card = client.access_cards.provision(
+    # ... parameters
+  )
+rescue AccessGrid::ValidationError => e
+  puts "Invalid parameters: #{e.message}"
+rescue AccessGrid::Error => e
+  puts "API error: #{e.message}"
+end
+```
+
+## Requirements
+
+- Ruby 2.6 or higher
+
+## Security
+
+The SDK automatically handles:
+- Request signing using HMAC-SHA256
+- Secure payload encoding
+- Authentication headers
+- HTTPS communication
+
+Never expose your `secret_key` in client-side code. Always use environment variables or a secure configuration management system.
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/accessgrid-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/lib/accessgrid/access_cards.rb

@@ -0,0 +1,52 @@
+# lib/accessgrid/access_cards.rb
+module AccessGrid
+  class AccessCards
+    def initialize(client)
+      @client = client
+    end
+
+    def provision(params)
+      response = @client.make_request(:post, '/api/v1/nfc_keys/issue', params)
+      Card.new(response)
+    end
+
+    def update(params)
+      card_id = params.delete(:card_id)
+      response = @client.make_request(:put, "/api/v1/nfc_keys/#{card_id}", params)
+      Card.new(response)
+    end
+
+    private def manage_state(card_id, action)
+      response = @client.make_request(
+        :post, 
+        "/api/v1/nfc_keys/#{card_id}/manage", 
+        { manage_action: action }
+      )
+      Card.new(response)
+    end
+
+    def suspend(params)
+      manage_state(params[:card_id], 'suspend')
+    end
+
+    def resume(params)
+      manage_state(params[:card_id], 'resume')
+    end
+
+    def unlink(params)
+      manage_state(params[:card_id], 'unlink')
+    end
+  end
+
+  class Card
+    attr_reader :id, :state, :url, :full_name, :expiration_date
+
+    def initialize(data)
+      @id = data['id']
+      @state = data['state']
+      @url = data['install_url']
+      @full_name = data['full_name']
+      @expiration_date = data['expiration_date']
+    end
+  end
+end

data/lib/accessgrid/console.rb

@@ -0,0 +1,80 @@
+# lib/accessgrid/console.rb
+module AccessGrid
+  class Console
+    def initialize(client)
+      @client = client
+    end
+
+    def create_template(params)
+      transformed_params = transform_template_params(params)
+      response = @client.make_request(:post, '/api/v1/enterprise/templates', transformed_params)
+      Template.new(response)
+    end
+
+    def update_template(params)
+      card_template_id = params.delete(:card_template_id)
+      transformed_params = transform_template_params(params)
+      response = @client.make_request(:put, "/api/v1/enterprise/templates/#{card_template_id}", transformed_params)
+      Template.new(response)
+    end
+
+    def read_template(params)
+      response = @client.make_request(:get, "/api/v1/enterprise/templates/#{params[:card_template_id]}")
+      Template.new(response)
+    end
+
+    def event_log(params)
+      card_template_id = params.delete(:card_template_id)
+      response = @client.make_request(:get, "/api/v1/enterprise/templates/#{card_template_id}/logs", params)
+      response['logs'].map { |log| Event.new(log) }
+    end
+
+    private
+
+    def transform_template_params(params)
+      design = params.delete(:design) || {}
+      support_info = params.delete(:support_info) || {}
+      
+      params.merge(
+        background_color: design[:background_color],
+        label_color: design[:label_color],
+        label_secondary_color: design[:label_secondary_color],
+        support_url: support_info[:support_url],
+        support_phone_number: support_info[:support_phone_number],
+        support_email: support_info[:support_email],
+        privacy_policy_url: support_info[:privacy_policy_url],
+        terms_and_conditions_url: support_info[:terms_and_conditions_url]
+      )
+    end
+  end
+
+  class Template
+    attr_reader :id, :name, :platform, :protocol, :allow_on_multiple_devices,
+                :watch_count, :iphone_count, :support_info, :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']
+      @style_settings = data['style_settings']
+    end
+  end
+
+  class Event
+    attr_reader :type, :timestamp, :user_id, :ip_address, :user_agent, :metadata
+
+    def initialize(data)
+      @type = data['event']
+      @timestamp = data['created_at']
+      @user_id = data['metadata']['user_id']
+      @ip_address = data['ip_address']
+      @user_agent = data['user_agent']
+      @metadata = data['metadata']
+    end
+  end
+end

data/lib/accessgrid/version.rb

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

data/lib/accessgrid.rb

@@ -0,0 +1,103 @@
+# lib/accessgrid.rb
+require 'base64'
+require 'json'
+require 'net/http'
+require 'openssl'
+require 'uri'
+
+require_relative 'accessgrid/version'
+require_relative 'accessgrid/access_cards'
+require_relative 'accessgrid/console'
+
+module AccessGrid
+  class Error < StandardError; end
+  class AuthenticationError < Error; end
+  class ResourceNotFoundError < Error; end
+  class ValidationError < Error; end
+  
+  class Client
+    attr_reader :account_id, :api_secret, :api_host
+    
+    def initialize(account_id, api_secret, api_host = 'https://api.accessgrid.com')
+      @account_id = account_id
+      @api_secret = api_secret
+      @api_host = api_host
+    end
+
+    def access_cards
+      @access_cards ||= AccessCards.new(self)
+    end
+
+    def console
+      @console ||= Console.new(self)
+    end
+
+    def make_request(method, path, body = nil)
+      uri = URI.parse("#{api_host}#{path}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+
+      # Create request object based on method
+      request = case method
+      when :get
+        Net::HTTP::Get.new(uri.request_uri)
+      when :post
+        Net::HTTP::Post.new(uri.request_uri)
+      when :put
+        Net::HTTP::Put.new(uri.request_uri)
+      else
+        raise ArgumentError, "Unsupported HTTP method: #{method}"
+      end
+
+      # Set headers
+      request['Content-Type'] = 'application/json'
+      request['X-ACCT-ID'] = account_id
+      
+      # Generate signature if body present
+      if body
+        json_body = body.to_json
+        request['X-PAYLOAD-SIG'] = generate_signature(json_body)
+        request.body = json_body
+      end
+
+      # Make request
+      response = http.request(request)
+      
+      # Parse response
+      handle_response(response)
+    end
+
+    private
+
+    def generate_signature(payload)
+      # Base64 encode the payload
+      encoded_payload = Base64.strict_encode64(payload)
+      
+      # Generate SHA256 hash
+      OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new('sha256'),
+        api_secret,
+        encoded_payload
+      )
+    end
+
+    def handle_response(response)
+      case response.code.to_i
+      when 200, 201, 202
+        JSON.parse(response.body)
+      when 401
+        raise AuthenticationError, 'Invalid credentials'
+      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}"
+      end
+    end
+  end
+
+  def self.new(account_id, api_secret, api_host = 'https://api.accessgrid.com')
+    Client.new(account_id, api_secret, api_host)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: accessgrid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Auston Bunsen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ruby client for the AccessGrid API
+email:
+- ab@accessgrid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/accessgrid.rb
+- lib/accessgrid/access_cards.rb
+- lib/accessgrid/console.rb
+- lib/accessgrid/version.rb
+homepage: https://github.com/access-grid/accessgrid-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: AccessGrid API Client
+test_files: []