loops_rails 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0f5a041a6bc29955f19f4f9f81ecb670233e2a8776772d8e894070eab38a6a
-  data.tar.gz: a6b3358e15f6b3dcf6db27999205c7ee6066ed08e9034840c20db4d51e106430
+  metadata.gz: f79d4af123b8a77eaf6ad7533bcab6d19e6178a5fbba0f21e73066db1009f50b
+  data.tar.gz: ff8d1fe3eb16b606a0914406672f30821d1a169f747ea2d6db1966df0ad99718
 SHA512:
-  metadata.gz: 87d31d93f2c08cd5305e533b18b5b0c295f40cdf478194e308189e87ea2d45964d41c21a93f75aed853a12e1f32d8c65a83539f1aa56c157b92cb533cc21c51f
-  data.tar.gz: 005f4aa20127104f6b35070b205a8ace43de454e225e4cbe86117b675abc4db6fcdd9b390fef0447e34cfc2c273d12ef0d3917b28e8fb472469ac7e0e4089c0f
+  metadata.gz: f7273b8e7c1bc6a8b4bf4e9c5e0b6be1eea2d32107c3d8f55f366b69e6f5b8feb3ba01586f0c115f27ae03717efb96b758d105b10af4c5d2b37c6d2679b8f692
+  data.tar.gz: a3eeab9a2f5ba91e4a86f6a678ea080a9905eb7cbb00009b9dab867a654c1d0e490031ca1804577641fc049cf6c06f46eae806c04306a1b482a42102848e2c39

data/README.md

@@ -1,24 +1,33 @@
 # LoopsRails
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/loops_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+LoopsRails is a Rails client for the [Loops](https://loops.so) API.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add loops_rails
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install loops_rails
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Sign up for a [Loops](https://loops.so) account.
+2. Create an API key in your account settings.
+3. Use the API key to authenticate requests to the API.
+
+```ruby
+client = LoopsRails::Client.new(api_key: "your_api_key")
+
+client.test_api_key
+client.contacts.create(email: "john@example.com")
+client.transactional_emails.send(
+  email: "john@example.com",
+  transactional_id: "your_transactional_id"
+)
+```
 
 ## Development
 
@@ -26,9 +35,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## TODO
+
+- [X] Add support for the `/api-key` endpoint
+- [X] Add support for the `/contacts` endpoint
+- [X] Add support for the `/transactional` endpoint
+- [ ] Add support for the `/lists` endpoint
+- [ ] Add support for the `/events` endpoint
+- [ ] Add support for the `/customFields` endpoint
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/loops_rails.
+Bug reports and pull requests are welcome on GitHub at https://github.com/danielfriis/loops_rails.
 
 ## License
 

data/lib/loops_rails/client/api_key.rb

@@ -1,7 +1,8 @@
 module LoopsRails
   class ApiKey < ApiResource
-    def test_api_key
+    def test
       response = @conn.get('api-key')
+
       parse_response(response)
     end
   end

data/lib/loops_rails/client/contacts.rb

@@ -24,9 +24,11 @@ module LoopsRails
       raise ArgumentError, "Either email or user_id must be provided" if email.nil? && user_id.nil?
 
       params = { email: email, userId: user_id }.compact
+
       response = @conn.get("contacts/find") do |req|
         req.params = params
       end
+
       parse_response(response)
     end
 

data/lib/loops_rails/client/custom_fields.rb

@@ -0,0 +1,9 @@
+module LoopsRails
+  class CustomFields < ApiResource
+    def list
+      response = @conn.get("contacts/customFields")
+
+      parse_response(response)
+    end
+  end
+end

data/lib/loops_rails/client/events.rb

@@ -0,0 +1,22 @@
+module LoopsRails
+  class Events < ApiResource
+    def send(email: nil, user_id: nil, event_name:, event_properties: {}, mailing_lists: {}, contact_properties: {})
+      raise ArgumentError, "Either email or user_id must be provided" if email.nil? && user_id.nil?
+
+      payload = {
+        email: email,
+        userId: user_id,
+        eventName: event_name,
+        eventProperties: event_properties,
+        mailingLists: mailing_lists,
+        contactProperties: contact_properties
+      }.compact.to_json
+
+      response = @conn.post('events/send') do |req|
+        req.body = payload
+      end
+
+      parse_response(response)
+    end
+  end
+end

data/lib/loops_rails/client/lists.rb

@@ -0,0 +1,9 @@
+module LoopsRails
+  class Lists < ApiResource
+    def list
+      response = @conn.get("lists")
+
+      parse_response(response)
+    end
+  end
+end

data/lib/loops_rails/client/transactional_emails.rb

@@ -1,14 +1,17 @@
 module LoopsRails
   class TransactionalEmails < ApiResource
     def send(email:, transactional_id:, data_variables: {}, attachments: [])
+      payload = {
+        email: email,
+        transactionalId: transactional_id,
+        dataVariables: data_variables,
+        attachments: attachments
+      }.compact.to_json
+
       response = @conn.post('transactional') do |req|
-        req.body = {
-          email: email,
-          transactionalId: transactional_id,
-          dataVariables: data_variables,
-          attachments: attachments
-        }.to_json
+        req.body = payload
       end
+
       parse_response(response)
     end
   end

data/lib/loops_rails/client.rb

@@ -13,13 +13,25 @@ module LoopsRails
     end
 
     def api_key
-      @api_key ||= ApiKey.new(@conn)
+      @api_key_endpoint ||= ApiKey.new(@conn)
     end
 
     def contacts
       @contacts ||= Contacts.new(@conn)
     end
 
+    def custom_fields
+      @custom_fields ||= CustomFields.new(@conn)
+    end
+
+    def lists
+      @lists ||= Lists.new(@conn)
+    end
+
+    def events
+      @events ||= Events.new(@conn)
+    end
+
     def transactional_emails
       @transactional_emails ||= TransactionalEmails.new(@conn)
     end

data/lib/loops_rails/version.rb

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

data/lib/loops_rails.rb

@@ -6,11 +6,13 @@ require_relative "loops_rails/version"
 require_relative "loops_rails/client"
 require_relative "loops_rails/configuration"
 require_relative "loops_rails/client/api_resource"
+require_relative "loops_rails/client/custom_fields"
+require_relative "loops_rails/client/events"
+require_relative "loops_rails/client/lists"
 require_relative "loops_rails/client/api_key"
 require_relative "loops_rails/client/contacts"
 require_relative "loops_rails/client/transactional_emails"
 
 module LoopsRails
   class Error < StandardError; end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loops_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Daniel Friis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,9 +40,14 @@ files:
 - lib/loops_rails/client/api_key.rb
 - lib/loops_rails/client/api_resource.rb
 - lib/loops_rails/client/contacts.rb
+- lib/loops_rails/client/custom_fields.rb
+- lib/loops_rails/client/events.rb
+- lib/loops_rails/client/lists.rb
 - lib/loops_rails/client/transactional_emails.rb
 - lib/loops_rails/configuration.rb
 - lib/loops_rails/version.rb
+- loops_rails-0.1.0.gem
+- loops_rails-0.1.1.gem
 - loops_rails.gemspec
 - sig/loops_rails.rbs
 homepage: https://github.com/danielfriis/loops_rails