email_list_api 0.1.0.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9f6eff66fff016c13db422fe77d7b6173a6389a4ebb48e56c6a976180fe78e9
+  data.tar.gz: 5eb26fa011aeb57b16a6d22dbfb422f69310c16d75a0750337c22c25771394bd
+SHA512:
+  metadata.gz: 5d8fa655ccabbdb642b73954f6a426a26ff8f6c92c8cb9a1b4bbf4f8e391977327779aaa5b78956e6fe1dcf8b978d0094b6650b478b4df3e17599b3df13c3790
+  data.tar.gz: 32760843f905f7c7918fd4b358394c10e57420b6eedc4f8b98b2ef24cac062d32f2c4bb6a307f30e180d6200acfaac527628ff423c768af94d8b896e33eb466d

data/README.md

@@ -0,0 +1,38 @@
+# EmailListApi
+
+A Ruby client for the Email List API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_list_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_list_api
+
+## Usage
+
+```ruby
+require 'email_list_api'
+
+client = EmailListApi::Client.new(api_key: 'your_api_key')
+
+# Projects
+projects = client.projects
+project = client.create_project(name: 'My Project')
+
+# Lists
+lists = client.lists(project_id: project['id'])
+list = client.create_list(project_id: project['id'], name: 'Newsletter')
+
+# Contacts
+client.create_contact(project_id: project['id'], email: 'user@example.com')
+```

data/lib/email_list_api/client.rb

@@ -0,0 +1,152 @@
+require 'faraday'
+require 'faraday/retry'
+require 'faraday/follow_redirects'
+require 'json'
+
+module EmailListApi
+  class Client
+    DEFAULT_BASE_URL = "http://localhost:3000/api/v1"
+
+    def initialize(api_key: ENV['EMAILLIST_API_KEY'], base_url: DEFAULT_BASE_URL)
+      @api_key = api_key
+      @base_url = base_url
+    end
+
+    # Projects
+    def projects
+      get("projects")
+    end
+
+    def project(id)
+      get("projects/#{id}")
+    end
+
+    def create_project(name:, description: nil)
+      post("projects", { project: { name: name, description: description } })
+    end
+
+    def update_project(id, name: nil, description: nil)
+      params = { project: {} }
+      params[:project][:name] = name if name
+      params[:project][:description] = description if description
+      patch("projects/#{id}", params)
+    end
+
+    def delete_project(id)
+      delete("projects/#{id}")
+    end
+
+    # Lists
+    def lists(project_id:)
+      get("projects/#{project_id}/lists")
+    end
+
+    def list(project_id:, id:)
+      get("projects/#{project_id}/lists/#{id}")
+    end
+
+    def create_list(project_id:, name:, description: nil)
+      post("projects/#{project_id}/lists", { list: { name: name, description: description } })
+    end
+
+    def update_list(project_id:, id:, name: nil, description: nil)
+      params = { list: {} }
+      params[:list][:name] = name if name
+      params[:list][:description] = description if description
+      patch("projects/#{project_id}/lists/#{id}", params)
+    end
+
+    def delete_list(project_id:, id:)
+      delete("projects/#{project_id}/lists/#{id}")
+    end
+
+    # Contacts
+    def contacts(project_id:, page: 1)
+      get("projects/#{project_id}/contacts", { page: page })
+    end
+
+    def contact(project_id:, id:)
+      get("projects/#{project_id}/contacts/#{id}")
+    end
+
+    def create_contact(project_id:, email:, first_name: nil, last_name: nil)
+      params = { contact: { email: email } }
+      params[:contact][:first_name] = first_name if first_name
+      params[:contact][:last_name] = last_name if last_name
+      post("projects/#{project_id}/contacts", params)
+    end
+
+    def update_contact(project_id:, id:, email: nil, first_name: nil, last_name: nil)
+      params = { contact: {} }
+      params[:contact][:email] = email if email
+      params[:contact][:first_name] = first_name if first_name
+      params[:contact][:last_name] = last_name if last_name
+      patch("projects/#{project_id}/contacts/#{id}", params)
+    end
+
+    def delete_contact(project_id:, id:)
+      delete("projects/#{project_id}/contacts/#{id}")
+    end
+
+    # List Memberships
+    def list_contacts(project_id:, list_id:)
+      get("projects/#{project_id}/lists/#{list_id}/contacts")
+    end
+
+    def add_contacts_to_list(project_id:, list_id:, contacts:)
+      # contacts can be an array of hashes or a single hash, but API expects array
+      contacts = [contacts] unless contacts.is_a?(Array)
+      post("projects/#{project_id}/lists/#{list_id}/contacts", { contacts: contacts })
+    end
+
+    def add_contact_to_list(project_id:, list_id:, contact_id:)
+      # Helper for adding single existing contact by ID
+      add_contacts_to_list(project_id: project_id, list_id: list_id, contacts: [{ id: contact_id }])
+    end
+
+    def remove_contact_from_list(project_id:, list_id:, contact_id:)
+      delete("projects/#{project_id}/lists/#{list_id}/contacts/#{contact_id}")
+    end
+
+    # Bulk Operations
+    def bulk_create_contacts(project_id:, contacts:)
+       post("projects/#{project_id}/contacts/bulk", { contacts: contacts })
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: @base_url) do |conn|
+        conn.request :json
+        conn.request :retry
+        conn.response :json, content_type: /\bjson$/
+        conn.response :raise_error
+        conn.response :follow_redirects
+        conn.headers['Authorization'] = "Bearer #{@api_key}"
+        conn.headers['Content-Type'] = 'application/json'
+        conn.headers['User-Agent'] = "EmailListApi Ruby Client/#{EmailListApi::VERSION}"
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def get(path, params = {})
+      response = connection.get(path, params)
+      response.body
+    end
+
+    def post(path, body = {})
+      response = connection.post(path, body)
+      response.body
+    end
+
+    def patch(path, body = {})
+      response = connection.patch(path, body)
+      response.body
+    end
+
+    def delete(path)
+      response = connection.delete(path)
+      response.body
+    end
+  end
+end

data/lib/email_list_api/version.rb

@@ -0,0 +1,3 @@
+module EmailListApi
+  VERSION = "0.1.0.rc.1"
+end

data/lib/email_list_api.rb

@@ -0,0 +1,6 @@
+require "email_list_api/version"
+require "email_list_api/client"
+
+module EmailListApi
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: email_list_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0.rc.1
+platform: ruby
+authors:
+- Email List Dev
+bindir: exe
+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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: A simple Ruby client for managing projects, lists, and contacts via the
+  Email List API.
+email:
+- dev@emaillist.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/email_list_api.rb
+- lib/email_list_api/client.rb
+- lib/email_list_api/version.rb
+homepage: https://github.com/yourusername/emaillist-ruby
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby client for Email List API
+test_files: []