loops_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0f5a041a6bc29955f19f4f9f81ecb670233e2a8776772d8e894070eab38a6a
-  data.tar.gz: a6b3358e15f6b3dcf6db27999205c7ee6066ed08e9034840c20db4d51e106430
+  metadata.gz: f4a01b300b7edd07daf94406b06af9fcc49ecca1a8f731240ead0bfa845baed9
+  data.tar.gz: 8891a9cce0094da646b82f24e1f9b29a9e1d9d567d7ef2baaad788cd6ceb9443
 SHA512:
-  metadata.gz: 87d31d93f2c08cd5305e533b18b5b0c295f40cdf478194e308189e87ea2d45964d41c21a93f75aed853a12e1f32d8c65a83539f1aa56c157b92cb533cc21c51f
-  data.tar.gz: 005f4aa20127104f6b35070b205a8ace43de454e225e4cbe86117b675abc4db6fcdd9b390fef0447e34cfc2c273d12ef0d3917b28e8fb472469ac7e0e4089c0f
+  metadata.gz: 84ec1a3d1406415776686e8cb97edb2dff593f8be3fc8592eb80f40ee838a89c991e15309af14e9ac6f46c44cec347e0f1a4302e8b229cc0adba2302bf632f14
+  data.tar.gz: 89474f2371cd1e2ca408e590aced6520a40d30540574a2c9d379df5b1b5b39a74756388b1cbd642e66681e0643c81617ab72ad06876f41c48d53416d925ff065

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.api_keys.test
+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 → test_api_key.rb}

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

data/lib/loops_rails/client.rb

@@ -12,8 +12,8 @@ module LoopsRails
       end
     end
 
-    def api_key
-      @api_key ||= ApiKey.new(@conn)
+    def test_api_key
+      TestApiKey.new(@conn).test
     end
 
     def contacts

data/lib/loops_rails/version.rb

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

data/lib/loops_rails.rb

@@ -6,11 +6,10 @@ 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/api_key"
+require_relative "loops_rails/client/test_api_key"
 require_relative "loops_rails/client/contacts"
 require_relative "loops_rails/client/transactional_emails"
 
 module LoopsRails
   class Error < StandardError; end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loops_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Friis
@@ -37,12 +37,13 @@ files:
 - Rakefile
 - lib/loops_rails.rb
 - lib/loops_rails/client.rb
-- lib/loops_rails/client/api_key.rb
 - lib/loops_rails/client/api_resource.rb
 - lib/loops_rails/client/contacts.rb
+- lib/loops_rails/client/test_api_key.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.gemspec
 - sig/loops_rails.rbs
 homepage: https://github.com/danielfriis/loops_rails