column_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88259c47704f5f8107180c9e96b9382be8a069f645fb70422b690ac4233584b8
-  data.tar.gz: dc3086ad497d5ebb3647c78250f6ff25a827b2bb3d5252f6c00199d178068f3f
+  metadata.gz: 73530bf2a0b110c13bd34d55231cc3e0d91ff44046221a7b74ea8ec2b380ef82
+  data.tar.gz: f41a16e9e40eff65511e43e85238708fe6c54027a8f006cdfe0d8fac8ad02533
 SHA512:
-  metadata.gz: ef355750084f74d9530b42a6e6a1d1672dc8260856e264a073170c72d6fed12607e272661b3e074c33a3ad1ae615bcfff64a755318f41737b2728dd403b924a0
-  data.tar.gz: e2ddf0b78305d4190a92195eaf128eaaba04e4d910626f5b6ef967cdc038dc42fd06bc31a4cb6fa302f0a101bab2eef1b4ec5f13659d3d99394229b5bf0f544e
+  metadata.gz: e3af56a1cf2c39c8f2e073fcefb302f9aec329c6f578c63e628c10aac54b88d5ac9493b57d77a270f24895bd8578eecdac02b65848a125399c79a4b056b925ba
+  data.tar.gz: 319b6972c7d192ad2900d8f7baf805fcdfd9fd90d0ed3a77afb0724b00f4341661abd67be927a4f8757f0ec4dd9a160dcc389dd88340992280b31977becdfa39

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/.rubocop.yml

@@ -16,3 +16,9 @@ Layout/LineLength:
 
 Style/Documentation:
   Enabled: false
+
+Style/OpenStructUse:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "webmock", "~> 3.19", ">= 3.19.1"

data/Gemfile.lock

@@ -1,15 +1,19 @@
 PATH
   remote: .
   specs:
-    column_api (0.0.1)
+    column_api (0.0.2)
       faraday (~> 2.8.1)
       faraday-parse_dates (~> 0.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     base64 (0.2.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     faraday (2.8.1)
       base64
@@ -18,12 +22,14 @@ GEM
     faraday-net_http (3.0.2)
     faraday-parse_dates (0.1.1)
       faraday (~> 2.0)
+    hashdiff (1.1.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     parallel (1.24.0)
     parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
+    public_suffix (5.0.4)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
@@ -58,6 +64,10 @@ GEM
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     unicode-display_width (2.5.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-22
@@ -68,6 +78,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  webmock (~> 3.19, >= 3.19.1)
 
 BUNDLED WITH
    2.4.13

data/README.md

@@ -1,28 +1,53 @@
 # ColumnApi
 
-**WIP**
+_This gem is under development and the API is unstable._
+
+[![Gem Version](https://badge.fury.io/rb/column_api.svg)](https://badge.fury.io/rb/column_api)
 
 Ruby bindings for [Column's API](https://column.com/docs/api).
 
 ## Installation
 
-gem "column_api", :git => "git://github.com/matiasleidemer/column_api.git"
+```ruby
+gem 'column_api', '~> 0.0.2'
+```
 
 ## Usage
 
 ```ruby
 client = ColumnApi::Client.new(api_key: ENV["COLUMN_API_KEY"])
 
-client.connection.get("entities").body
-# => {"entities"=>[{"documents"=>[], "id"=>"enti_2aELWf6D", ...
+client.entities.retrieve(entity_id: "enti_2aELWf6D")
+# => #<ColumnApi::PersonEntity documents=[], id="enti_2aELWf6D", is_root=true, type="PERSON" (...)>
+```
+
+Alternatively, you can query the endpoints directly:
 
+```ruby
 client.connection.get("entities/enti_2aELWf6D").body
 # =>
 # {"documents"=>[],
 #  "id"=>"enti_2aELWf6D",
 #  "is_root"=>true,
 #  "person_details"=> {...}
-# etc
+# }
+```
+
+## Resources
+
+### Entities
+
+https://column.com/docs/api/#entity/object
+
+```ruby
+client.entities.list({})
+client.entities.retrieve(entity_id: "ID")
+client.entities.create_person({})
+client.entities.create_business({})
+client.entities.update_person(entity_id:, params: {})
+client.entities.update_business(entity_id:, params: {})
+client.entities.delete(entity_id: "ID")
+client.entities.submit_document(entity_id: "ID", params: {})
 ```
 
 ## Development

data/lib/column_api/client.rb

@@ -2,15 +2,18 @@
 
 module ColumnApi
   class Client
-    BASE_URL = "https://api.column.com/"
+    attr_reader :api_key, :base_url, :adapter
 
-    attr_reader :api_key, :adapter
-
-    def initialize(api_key:, adapter: Faraday.default_adapter)
+    def initialize(api_key:, base_url: BASE_URL, adapter: Faraday.default_adapter)
       @api_key = api_key
+      @base_url = base_url
       @adapter = adapter
     end
 
+    def entities
+      EntityResource.new(self)
+    end
+
     def connection
       @connection ||= Faraday.new(BASE_URL) do |conn|
         conn.request :authorization, :basic, "", api_key

data/lib/column_api/collection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class Collection
+    attr_reader :data, :has_more
+
+    def self.from_response(response, key:, type:)
+      new(
+        data: response[key].map do |attrs|
+          if type.respond_to?(:from_response)
+            type.from_response(attrs)
+          else
+            type.new(attrs)
+          end
+        end,
+        has_more: response["has_more"]
+      )
+    end
+
+    def initialize(data:, has_more:)
+      @data = data
+      @has_more = has_more
+    end
+  end
+end

data/lib/column_api/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class Error < StandardError; end
+  class BadRequestError < StandardError; end
+  class UnauthorizedError < StandardError; end
+end

data/lib/column_api/object.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "json"
+require "ostruct"
+
+module ColumnApi
+  class Object < OpenStruct
+    def initialize(attributes)
+      super(to_ostruct(attributes))
+    end
+
+    def to_ostruct(obj)
+      JSON.parse obj.to_json, object_class: OpenStruct
+    end
+  end
+end

data/lib/column_api/objects/business_entity.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class BusinessEntity < Object
+  end
+end

data/lib/column_api/objects/person_entity.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class PersonEntity < Object
+  end
+end

data/lib/column_api/resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, headers)
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise BadRequestError, response.body["message"]
+      when 401
+        raise UnauthorizedError, "Unauthorized"
+      end
+
+      response
+    end
+  end
+end

data/lib/column_api/resources/entity_resource.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ColumnApi
+  class EntityResource < Resource
+    def self.from_response(response)
+      if response["type"] == "PERSON"
+        PersonEntity.new(response)
+      else
+        BusinessEntity.new(response)
+      end
+    end
+
+    def retrieve(entity_id:)
+      EntityResource.from_response get_request("entities/#{entity_id}").body
+    end
+
+    def list(params = {})
+      response = get_request("entities", params: params).body
+      Collection.from_response(response, key: "entities", type: EntityResource)
+    end
+
+    def create_person(params)
+      PersonEntity.new post_request("entities/person", body: params).body
+    end
+
+    def update_person(entity_id:, params:)
+      PersonEntity.new patch_request("entities/person/#{entity_id}", body: params).body
+    end
+
+    def create_business(params)
+      BusinessEntity.new post_request("entities/business", body: params).body
+    end
+
+    def update_business(entity_id:, params:)
+      BusinessEntity.new patch_request("entities/business/#{entity_id}", body: params).body
+    end
+
+    def delete(entity_id:)
+      delete_request("entities/#{entity_id}")
+      true
+    end
+
+    def submit_document(entity_id:, params:)
+      EntityResource.from_response(
+        post_request("entities/#{entity_id}/documents", body: params).body
+      )
+    end
+  end
+end

data/lib/column_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ColumnApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/column_api.rb

@@ -4,7 +4,20 @@ require "faraday"
 require "faraday/parse_dates"
 
 require_relative "column_api/version"
+require_relative "column_api/errors"
 
 module ColumnApi
+  BASE_URL = "https://api.column.com/"
+
   autoload :Client, "column_api/client"
+  autoload :Object, "column_api/object"
+  autoload :Collection, "column_api/collection"
+  autoload :Resource, "column_api/resource"
+
+  # Objects
+  autoload :BusinessEntity, "column_api/objects/business_entity"
+  autoload :PersonEntity, "column_api/objects/person_entity"
+
+  # Resources
+  autoload :EntityResource, "column_api/resources/entity_resource"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: column_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matias Leidemer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-30 00:00:00.000000000 Z
+date: 2023-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -54,9 +54,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- column_api.gemspec
 - lib/column_api.rb
 - lib/column_api/client.rb
+- lib/column_api/collection.rb
+- lib/column_api/errors.rb
+- lib/column_api/object.rb
+- lib/column_api/objects/business_entity.rb
+- lib/column_api/objects/person_entity.rb
+- lib/column_api/resource.rb
+- lib/column_api/resources/entity_resource.rb
 - lib/column_api/version.rb
 - sig/column_api.rbs
 homepage: https://github.com/matiasleidemer/column_api

data/column_api.gemspec

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/column_api/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "column_api"
-  spec.version = ColumnApi::VERSION
-  spec.authors = ["Matias Leidemer"]
-  spec.email = ["matiasleidemer@gmail.com"]
-
-  spec.summary = "Ruby bindings for Column API"
-  spec.description = "Ruby bindings for Column API. https://column.com/docs/api"
-  spec.homepage = "https://github.com/matiasleidemer/column_api"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday", "~> 2.8.1"
-  spec.add_dependency "faraday-parse_dates", "~> 0.1.1"
-end