infakt_api_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb835834326f5229f5a2f908fd3dd27b019549c4e20fc80e05713debf88c7dae
+  data.tar.gz: c8918b2d0f8fa66f4d82b21d62c66b9e5ed3cb254508b368a6119eb831537b65
+SHA512:
+  metadata.gz: d4a2382ff69f5158bd50c279e76982925f3dab2e5b92687da09fb48c631b2a022394216a60b6c4252ab076086616e794cf8b0211b338f767c2a699a2efb74483
+  data.tar.gz: ce1d185ee8baad237dea8fddf4c31dd5364e73f3d03e4146044a9030bf6c2ae3e2aaeb3a3cb384f38ac4694b52182c05b75a8c49173fcedf32a47c285f5ec90f

data/README.md

@@ -0,0 +1,58 @@
+# InfaktApiClient
+
+A Ruby client library for the Infakt API, providing easy access to Infakt's invoicing and accounting services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'infakt_api_client'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install infakt_api_client
+```
+
+## Usage
+
+First, configure the client with your API key:
+
+```ruby
+InfaktApiClient.configure do |config|
+  config.api_key = 'your_api_key_here'
+end
+```
+
+### Examples
+
+```ruby
+# Create a new client
+client = InfaktApiClient.new
+
+# Fetch user details
+user = client.user_details
+```
+
+## Documentation
+
+For detailed documentation of available methods and options, please visit our [Wiki](https://github.com/mateuszpalak/infakt_api_client/wiki).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mateuszpalak/infakt_api_client.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.

data/lib/infakt_api_client/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module InfaktApiClient
+  # Client class for interacting with the inFakt API
+  # Manages HTTP communication and authentication with the API endpoints
+  class Client
+    # Add HTTP status constants for better readability
+    HTTP_OK = 200
+    HTTP_UNAUTHORIZED = 401
+    HTTP_NOT_FOUND = 404
+
+    def initialize
+      @connection = Faraday.new(url: InfaktApiClient.configuration.api_endpoint) do |faraday|
+        configure_connection(faraday)
+      end
+    end
+
+    def user_details
+      response = @connection.get("account/details.json")
+      handle_response(response) do |data|
+        User.new(data)
+      end
+    end
+
+    private
+
+    def configure_connection(faraday)
+      faraday.headers["X-inFakt-ApiKey"] = InfaktApiClient.configuration.api_key
+      faraday.headers["Content-Type"] = "application/json"
+      faraday.adapter Faraday.default_adapter
+      faraday.response :json # Automatically parse JSON responses
+    end
+
+    def handle_response(response)
+      case response.status
+      when HTTP_OK
+        yield response.body # No need to parse JSON manually now
+      when HTTP_UNAUTHORIZED
+        raise Error, "Unauthorized - check your API key"
+      when HTTP_NOT_FOUND
+        raise Error, "Resource not found"
+      else
+        raise Error, build_error_message(response)
+      end
+    end
+
+    def build_error_message(response)
+      "API error (status: #{response.status}): #{response.body}"
+    end
+  end
+end

data/lib/infakt_api_client/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module InfaktApiClient
+  # Configuration class for InfaktApiClient
+  # Manages API credentials and endpoint settings for the inFakt API integration
+  class Configuration
+    DEFAULT_ENDPOINT = "https://api.niebieskiorzel.pl/v3/"
+
+    attr_accessor :api_key
+    attr_reader :api_endpoint
+
+    def initialize
+      @api_endpoint = DEFAULT_ENDPOINT
+      @api_key = nil
+    end
+
+    def api_endpoint=(url)
+      @api_endpoint = url.end_with?("/") ? url : "#{url}/"
+    end
+
+    def valid?
+      !api_key.nil? && !api_key.empty? && !api_endpoint.nil? && !api_endpoint.empty?
+    end
+  end
+end

data/lib/infakt_api_client/user.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module InfaktApiClient
+  # Represents a user in the Infakt API system, containing account information,
+  # company details, subscription status, and various settings. This class serves
+  # as a wrapper for user-related data returned by the Infakt API.
+  class User
+    attr_reader :account_data, :company_data, :current_subscription,
+                :accounting_settings, :accounting_office_service,
+                :foundation_process, :extensions
+
+    # Represents account-specific information for a user in the Infakt API system.
+    # Contains basic user identification and authentication details such as UUID,
+    # email, username, and registration information.
+    class AccountData
+      attr_reader :uuid, :email, :username, :site, :role, :registered_at
+
+      def initialize(data)
+        @uuid = data["uuid"]
+        @email = data["email"]
+        @username = data["username"]
+        @site = data["site"]
+        @role = data["role"]
+        @registered_at = data["registered_at"]
+      end
+    end
+
+    # Represents company-specific information for a user in the Infakt API system.
+    # Contains detailed business information such as company name, address details,
+    # tax identification numbers, and contact information.
+    class CompanyData
+      attr_reader :first_name, :last_name, :company_name, :owner_name, :owner_surname,
+                  :street, :street_name, :street_number, :flat_number, :city,
+                  :postal_code, :tax_id, :pesel, :regon, :phone_number,
+                  :mailing_company_name, :mailing_street, :mailing_city,
+                  :mailing_postal_code, :business_activity_code
+
+      def initialize(data)
+        @first_name = data["first_name"]
+        @last_name = data["last_name"]
+        @company_name = data["company_name"]
+        @owner_name = data["owner_name"]
+        @owner_surname = data["owner_surname"]
+        @street = data["street"]
+        @street_name = data["street_name"]
+        @street_number = data["street_number"]
+        @flat_number = data["flat_number"]
+        @city = data["city"]
+        @postal_code = data["postal_code"]
+        @tax_id = data["tax_id"]
+        @pesel = data["pesel"]
+        @regon = data["regon"]
+        @phone_number = data["phone_number"]
+        @mailing_company_name = data["mailing_company_name"]
+        @mailing_street = data["mailing_street"]
+        @mailing_city = data["mailing_city"]
+        @mailing_postal_code = data["mailing_postal_code"]
+        @business_activity_code = data["business_activity_code"]
+      end
+
+      def full_address
+        [street, city, postal_code].compact.join(", ")
+      end
+    end
+
+    # Represents subscription information for an InfaktApiClient user
+    class Subscription
+      attr_reader :name, :expired_on, :days_until_expiration, :user_type_symbol
+
+      def initialize(data)
+        @name = data["name"]
+        @expired_on = data["expired_on"]
+        @days_until_expiration = data["days_until_expiration"]
+        @user_type_symbol = data["user_type_symbol"]
+      end
+    end
+
+    def initialize(attributes)
+      @account_data = AccountData.new(attributes["account_data"])
+      @company_data = CompanyData.new(attributes["company_data"])
+      @current_subscription = Subscription.new(attributes["current_subscription"])
+      @accounting_settings = attributes["accounting_settings"]
+      @accounting_office_service = attributes["accounting_office_service"]
+      @foundation_process = attributes["foundation_process"]
+      @extensions = attributes["extentions"]
+    end
+
+    def full_name
+      "#{company_data.first_name} #{company_data.last_name}".strip
+    end
+
+    def subscription_active?
+      Date.parse(current_subscription.expired_on) > Date.today
+    end
+
+    def days_to_subscription_end
+      current_subscription.days_until_expiration
+    end
+
+    def ksef_active?
+      extensions.dig("ksef", "active")
+    end
+  end
+end

data/lib/infakt_api_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module InfaktApiClient
+  VERSION = "0.1.0"
+end

data/lib/infakt_api_client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+require "infakt_api_client/version"
+require "infakt_api_client/configuration"
+require "infakt_api_client/client"
+require "infakt_api_client/user"
+
+# Module for interacting with the inFakt.pl API
+# @see https://www.infakt.pl/developers/
+module InfaktApiClient
+  # Custom error class for InfaktApiClient specific exceptions
+  class Error < StandardError; end
+
+  # Configuration not initialized error
+  class ConfigurationError < Error; end
+
+  class << self
+    attr_writer :configuration
+
+    # @return [Configuration] Current configuration instance
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configures the client through a block
+    # @yield [config] Configuration instance
+    # @raise [ConfigurationError] if no block is given
+    def configure
+      yield(configuration)
+    rescue LocalJumpError
+      raise ConfigurationError, "Configuration block is required"
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: infakt_api_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Palak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: json
+  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'
+description: Prosty klient Ruby do integracji z API inFakt.pl
+email:
+- mateusz.palak@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/infakt_api_client.rb
+- lib/infakt_api_client/client.rb
+- lib/infakt_api_client/configuration.rb
+- lib/infakt_api_client/user.rb
+- lib/infakt_api_client/version.rb
+homepage: https://github.com/mateuszpalak/infakt_api_client
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.6
+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: Klient API dla systemu fakturowego inFakt.pl
+test_files: []