azure_file_shares 0.1.5

data/lib/azure_file_shares/operations/file_shares_operations.rb

@@ -0,0 +1,78 @@
+module AzureFileShares
+  module Operations
+    # Operations for Azure File Shares
+    class FileSharesOperations < BaseOperation
+      # List all file shares in the storage account
+      # @param [Hash] options Query parameters
+      # @option options [Integer] :maxpagesize The maximum items per page
+      # @option options [String] :filter Filter string
+      # @return [Array<AzureFileShares::Resources::FileShare>] Collection of file shares
+      def list(options = {})
+        path = "#{base_path}/fileServices/default/shares"
+        response = request(:get, path, options)
+
+        shares = response["value"] || []
+        shares.map { |share_data| AzureFileShares::Resources::FileShare.new(share_data) }
+      end
+
+      # Get a specific file share by name
+      # @param [String] share_name Name of the file share
+      # @param [Hash] options Query parameters
+      # @return [AzureFileShares::Resources::FileShare] File share details
+      def get(share_name, options = {})
+        path = "#{base_path}/fileServices/default/shares/#{share_name}"
+        response = request(:get, path, options)
+
+        AzureFileShares::Resources::FileShare.new(response)
+      end
+
+      # Create a new file share
+      # @param [String] share_name Name of the file share
+      # @param [Hash] properties Share properties
+      # @option properties [Integer] :shareQuota The maximum size of the share in GiB
+      # @option properties [String] :accessTier Access tier (Hot, Cool, Premium)
+      # @option properties [Boolean] :enabledProtocols Enabled protocols (SMB, NFS)
+      # @return [AzureFileShares::Resources::FileShare] Created file share
+      def create(share_name, properties = {})
+        path = "#{base_path}/fileServices/default/shares/#{share_name}"
+
+        body = {
+          properties: properties,
+        }
+
+        response = request(:put, path, {}, body)
+        AzureFileShares::Resources::FileShare.new(response)
+      end
+
+      # Update an existing file share
+      # @param [String] share_name Name of the file share
+      # @param [Hash] properties Share properties to update
+      # @return [AzureFileShares::Resources::FileShare] Updated file share
+      def update(share_name, properties = {})
+        path = "#{base_path}/fileServices/default/shares/#{share_name}"
+
+        body = {
+          properties: properties,
+        }
+
+        response = request(:patch, path, {}, body)
+        AzureFileShares::Resources::FileShare.new(response)
+      end
+
+      # Delete a file share
+      # @param [String] share_name Name of the file share
+      # @param [Hash] options Query parameters
+      # @option options [Boolean] :delete_snapshots Whether to delete snapshots
+      # @return [Boolean] true if successful
+      def delete(share_name, options = {})
+        path = "#{base_path}/fileServices/default/shares/#{share_name}"
+
+        delete_options = {}
+        delete_options[:deleteSnapshots] = options[:delete_snapshots] if options[:delete_snapshots]
+
+        request(:delete, path, delete_options)
+        true
+      end
+    end
+  end
+end

data/lib/azure_file_shares/operations/snapshots_operations.rb

@@ -0,0 +1,62 @@
+module AzureFileShares
+  module Operations
+    # Operations for Azure File Share Snapshots
+    class SnapshotsOperations < BaseOperation
+      # Create a snapshot of a file share
+      # @param [String] share_name Name of the file share
+      # @param [Hash] metadata Optional metadata for the snapshot
+      # @return [AzureFileShares::Resources::FileShareSnapshot] Created snapshot
+      def create(share_name, metadata = {})
+        path = "#{base_path}/fileServices/default/shares/#{share_name}/snapshots"
+
+        body = {}
+        body[:metadata] = metadata unless metadata.empty?
+
+        response = request(:post, path, {}, body)
+        AzureFileShares::Resources::FileShareSnapshot.new(response)
+      end
+
+      # List snapshots of a file share
+      # @param [String] share_name Name of the file share
+      # @param [Hash] options Query parameters
+      # @return [Array<AzureFileShares::Resources::FileShareSnapshot>] Collection of snapshots
+      def list(share_name, options = {})
+        path = "#{base_path}/fileServices/default/shares/#{share_name}/snapshots"
+        response = request(:get, path, options)
+
+        snapshots = response["value"] || []
+        snapshots.map { |snapshot_data| AzureFileShares::Resources::FileShareSnapshot.new(snapshot_data) }
+      end
+
+      # Get a specific snapshot by share name and snapshot timestamp
+      # @param [String] share_name Name of the file share
+      # @param [String] snapshot_timestamp Timestamp of the snapshot
+      # @return [AzureFileShares::Resources::FileShareSnapshot] Snapshot details
+      def get(share_name, snapshot_timestamp)
+        path = "#{base_path}/fileServices/default/shares/#{share_name}"
+
+        options = {
+          sharesnapshot: snapshot_timestamp,
+        }
+
+        response = request(:get, path, options)
+        AzureFileShares::Resources::FileShareSnapshot.new(response)
+      end
+
+      # Delete a specific snapshot
+      # @param [String] share_name Name of the file share
+      # @param [String] snapshot_timestamp Timestamp of the snapshot
+      # @return [Boolean] true if successful
+      def delete(share_name, snapshot_timestamp)
+        path = "#{base_path}/fileServices/default/shares/#{share_name}"
+
+        options = {
+          sharesnapshot: snapshot_timestamp,
+        }
+
+        request(:delete, path, options)
+        true
+      end
+    end
+  end
+end

data/lib/azure_file_shares/resources/file_share.rb

@@ -0,0 +1,80 @@
+module AzureFileShares
+  module Resources
+    # Represents an Azure File Share resource
+    class FileShare
+      attr_reader :id, :name, :type, :etag, :properties, :metadata
+
+      # Initialize a new FileShare object from API response
+      # @param [Hash] data API response data
+      def initialize(data)
+        @id = data["id"]
+        @name = data["name"]
+        @type = data["type"]
+        @etag = data["etag"]
+        @properties = data["properties"] || {}
+        @metadata = data["metadata"] || {}
+      end
+
+      # Get the provisioned capacity in GiB
+      # @return [Integer] Quota in GiB
+      def quota
+        properties["shareQuota"]
+      end
+
+      # Get the access tier (Hot, Cool, Premium)
+      # @return [String] Access tier
+      def access_tier
+        properties["accessTier"]
+      end
+
+      # Get the last modified time
+      # @return [Time, nil] Last modified time or nil if not available
+      def last_modified_time
+        time_str = properties["lastModifiedTime"]
+        Time.parse(time_str) if time_str
+      rescue ArgumentError, TypeError
+        nil
+      end
+
+      # Get the creation time
+      # @return [Time, nil] Creation time or nil if not available
+      def creation_time
+        time_str = properties["creationTime"]
+        Time.parse(time_str) if time_str
+      rescue ArgumentError, TypeError
+        nil
+      end
+
+      # Get the enabled protocols
+      # @return [String] Enabled protocols (SMB, NFS)
+      def enabled_protocols
+        properties["enabledProtocols"]
+      end
+
+      # Get the lease state
+      # @return [String] Lease state
+      def lease_state
+        properties["leaseState"]
+      end
+
+      # Get the lease status
+      # @return [String] Lease status
+      def lease_status
+        properties["leaseStatus"]
+      end
+
+      # Convert object to a hash
+      # @return [Hash] The file share as a hash
+      def to_h
+        {
+          id: id,
+          name: name,
+          type: type,
+          etag: etag,
+          properties: properties,
+          metadata: metadata,
+        }
+      end
+    end
+  end
+end

data/lib/azure_file_shares/resources/file_share_snapshot.rb

@@ -0,0 +1,75 @@
+module AzureFileShares
+  module Resources
+    # Represents an Azure File Share Snapshot resource
+    class FileShareSnapshot
+      attr_reader :id, :name, :type, :etag, :properties, :metadata, :share_name, :snapshot_time
+
+      # Initialize a new FileShareSnapshot object from API response
+      # @param [Hash] data API response data
+      def initialize(data)
+        @id = data["id"]
+        @name = data["name"]
+        @type = data["type"]
+        @etag = data["etag"]
+        @properties = data["properties"] || {}
+        @metadata = data["metadata"] || {}
+
+        # Extract snapshot time from properties directly
+        @snapshot_time = properties["snapshot"] if properties && properties["snapshot"]
+
+        # Extract share name and snapshot time from the ID
+        parse_id if @id
+      end
+
+      # Get the provisioned capacity in GiB
+      # @return [Integer] Quota in GiB
+      def quota
+        properties["shareQuota"]
+      end
+
+      # Get the snapshot timestamp
+      # @return [String] Snapshot timestamp
+      def timestamp
+        properties["snapshot"]
+      end
+
+      # Get the creation time
+      # @return [Time, nil] Creation time or nil if not available
+      def creation_time
+        time_str = properties["creationTime"]
+        Time.parse(time_str) if time_str
+      rescue ArgumentError, TypeError
+        nil
+      end
+
+      # Convert object to a hash
+      # @return [Hash] The snapshot as a hash
+      def to_h
+        {
+          id: id,
+          name: name,
+          type: type,
+          etag: etag,
+          properties: properties,
+          metadata: metadata,
+          share_name: share_name,
+          snapshot_time: snapshot_time,
+        }
+      end
+
+      private
+
+      # Parse the resource ID to extract share name
+      def parse_id
+        return unless id
+
+        parts = id.split("/")
+        # Find the index of 'shares' and get the next part as the share name
+        shares_index = parts.index("shares")
+        if shares_index && shares_index < parts.length - 1
+          @share_name = parts[shares_index + 1]
+        end
+      end
+    end
+  end
+end

data/lib/azure_file_shares/version.rb

@@ -0,0 +1,3 @@
+module AzureFileShares
+  VERSION = "0.1.5"
+end

data/lib/azure_file_shares.rb

@@ -0,0 +1,54 @@
+require "faraday"
+require "faraday/retry"
+require "json"
+require "uri"
+require "nokogiri"
+
+require_relative "azure_file_shares/version"
+require_relative "azure_file_shares/configuration"
+require_relative "azure_file_shares/client"
+
+# Auth
+require_relative "azure_file_shares/auth/token_provider"
+
+# Resources
+require_relative "azure_file_shares/resources/file_share"
+require_relative "azure_file_shares/resources/file_share_snapshot"
+
+# Operations
+require_relative "azure_file_shares/operations/base_operation"
+require_relative "azure_file_shares/operations/file_shares_operations"
+require_relative "azure_file_shares/operations/snapshots_operations"
+require_relative "azure_file_shares/operations/file_operations"
+
+# Errors
+require_relative "azure_file_shares/errors/api_error"
+require_relative "azure_file_shares/errors/configuration_error"
+
+# Main module for Azure File Shares API client
+module AzureFileShares
+  class << self
+    attr_accessor :configuration
+
+    # Configure the AzureFileShares client
+    # @yield [config] Configuration object
+    # @return [AzureFileShares::Configuration]
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+      configuration
+    end
+
+    # Get or create a new client instance
+    # @return [AzureFileShares::Client]
+    def client
+      @client ||= Client.new(configuration)
+    end
+
+    # Reset the configuration
+    # @return [AzureFileShares::Configuration]
+    def reset
+      self.configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: azure_file_shares
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Dmitry Trager
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: A Ruby gem for interacting with the Microsoft Azure File Shares API
+email:
+- dmitry.trager@revealbot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Readme.md
+- lib/azure_file_shares.rb
+- lib/azure_file_shares/auth/token_provider.rb
+- lib/azure_file_shares/client.rb
+- lib/azure_file_shares/configuration.rb
+- lib/azure_file_shares/errors/api_error.rb
+- lib/azure_file_shares/errors/configuration_error.rb
+- lib/azure_file_shares/operations/base_operation.rb
+- lib/azure_file_shares/operations/file_operations.rb
+- lib/azure_file_shares/operations/file_shares_operations.rb
+- lib/azure_file_shares/operations/snapshots_operations.rb
+- lib/azure_file_shares/resources/file_share.rb
+- lib/azure_file_shares/resources/file_share_snapshot.rb
+- lib/azure_file_shares/version.rb
+homepage: https://github.com/dmitrytrager/azure_file_shares
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dmitrytrager/azure_file_shares
+  source_code_uri: https://github.com/dmitrytrager/azure_file_shares
+  changelog_uri: https://github.com/dmitrytrager/azure_file_shares/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/dmitrytrager/azure_file_shares/blob/main/README.md
+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.7.1
+specification_version: 4
+summary: Ruby client for Microsoft Azure File Shares API
+test_files: []