primotexto 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f253be2828781bb54cbe4afb000a630a0c66251a
-  data.tar.gz: e3af78a14752af77c3c7d60e153a2eec83c3b476
+  metadata.gz: 76f0e403cc818bc34074d2c133f6c6364d6b7a30
+  data.tar.gz: bc35eaf8b1cb39460a041a34d98aaffb7b0ec858
 SHA512:
-  metadata.gz: bc4fbfc056f9399cd3cb63b3be25a7e6eb8d2616783945d94b6b59d96e412ecae4feac6b45476dbd0ceb564af5926ad71dcaa4d8b9a00229a9ade751a2d266b1
-  data.tar.gz: c67ca0dedc222fd732d00803f04f54fe9ae70806438ff71dd544898997c7c5d5fb4f53461c05365b9c637392a11ffa83e6b407b8ff46142a4e631f76d5b4ea8b
+  metadata.gz: 48ffcd5fe10be32969ee1cb8b63f6572603b84ee8cbc877ece3b49d41de462f15053c8c87414f2f50e2720d701d055b4dd81ffb48a02d016867ebbfd9a2b2346
+  data.tar.gz: 8297adaeea726ef22edf747c28d896fb011e74bae4b48ec5d03471526ddcb8f4246add46eee8efee8723f469be4e1afd6887f7f1b99e0ea09ee537e0bdcdf29b

data/README.md

@@ -10,6 +10,12 @@ Add this line to your application's Gemfile:
 gem 'primotexto'
 ```
 
+Or from Github to install the 'edge' version:
+
+```ruby
+gem 'primotexto', github: 'syntaxTerr0r/primotexto'
+```
+
 And then execute:
 
     $ bundle
@@ -21,6 +27,7 @@ Or install it yourself as:
 ## Usage
 
 All API methods are not implemented yet. Here is an exhaustive list of what is currently supported.
+Methods naming try to follow the API naming, however some changes has been made to make some name more friendly.
 
 ### Initializing a new client
 
@@ -28,7 +35,7 @@ All API methods are not implemented yet. Here is an exhaustive list of what is c
 pt = Primotexto.client(key: 'MY_SHINY_API_KEY')
 ```
 
-Alternatively, you can define the key in the `PRIMOTEXTO_API_KEY` `ENV` variable:
+Alternatively, you can define the key in an `ENV` variable: `PRIMOTEXTO_API_KEY`
 
 ```ruby
 pt = Primotexto.client
@@ -108,7 +115,7 @@ pt.get_unsubscribers_contacts
 pt.post_unsubscribers_contacts(identifier: '+33612345678')
 ```
 
-##### Removing a phone number from unsubscribers list
+#### Removing a phone number from unsubscribers list
 
 [API reference](https://www.primotexto.com/api/account/stats.asp)
 
@@ -132,7 +139,7 @@ pt.get_bounces_contacts
 pt.post_bounces_contacts(identifier: '+33612345678')
 ```
 
-##### Removing a phone number from bounces list
+#### Removing a phone number from bounces list
 
 [API reference](https://www.primotexto.com/api/account/stats.asp)
 
@@ -140,6 +147,28 @@ pt.post_bounces_contacts(identifier: '+33612345678')
 pt.delete_bounces_contacts(identifier: '+33612345678')
 ```
 
+### Contacts lists
+
+[API reference](https://www.primotexto.com/api/lists/contacts/index.asp)
+
+#### Creating a list
+
+```ruby
+vip_list = pt.post_lists(name: 'VIP People')
+```
+
+#### Adding a contact to a list
+
+```ruby
+vip_contact = pt.post_list_contact(list_id: vip_list[:id], identifier: '+33612345678')
+```
+
+#### Removing a contact from a list
+
+```ruby
+pt.delete_list_contact(list_id: vip_list[:id], contact_id: vip_contact[:id], identifier: '+33612345678')
+```
+
 ### Getting you account stats
 
 [API reference](https://www.primotexto.com/api/account/stats.asp)

data/lib/primotexto/client/constants.rb

@@ -47,6 +47,10 @@ module Primotexto
       ['get_unsubscribers_contacts', 'get_unsubscribers_default_contacts'],
       ['post_unsubscribers_contacts', 'post_unsubscribers_default_contacts_params'],
       ['delete_unsubscribers_contacts', 'delete_unsubscribers_default_contacts_params'],
+      'post_lists_params',
+      ['post_list_contact', 'post_lists-id_params'],
+      ['delete_list_contact', 'delete_lists-id_contacts-id_params'],
+
     ].freeze
   end
 end

data/lib/primotexto/client/http.rb

@@ -52,10 +52,10 @@ module Primotexto
           http_response.body
         end
       when Net::HTTPUnauthorized
-        raise AuthenticationError
+        fail AuthenticationError
       else
         error_code = JSON.parse(http_response.body)['code']
-        raise Error, "#{ERROR_CODES[error_code]} (code: #{error_code})"
+        fail Error, "#{ERROR_CODES[error_code]} (code: #{error_code})"
       end
     end
 

data/lib/primotexto/client.rb

@@ -1,3 +1,4 @@
+require 'active_support/inflector'
 require "primotexto/client/constants"
 require "primotexto/client/http"
 
@@ -9,6 +10,53 @@ module Primotexto
       @key = options.fetch(:key) { ENV.fetch('PRIMOTEXTO_API_KEY') }
     end
 
+    class << self
+      def ids_to_params(ids)
+        ids.map { |id| id_to_param(id) }
+      end
+
+      def id_to_param(id)
+        parts = id.split('-')
+        name = ActiveSupport::Inflector.singularize(parts.first)
+        parts[0] = name
+        parts.join('_').to_sym
+      end
+
+      private
+
+      def no_params_behaviour(verb, uri)
+        -> { send(verb, uri) }
+      end
+
+      def params_behaviour(verb, uri)
+        -> (params) { send(verb, uri, params) }
+      end
+
+      def params_with_ids_behaviour(verb, method, ids)
+        lambda do |params|
+          # Validating uri params presence
+          Client.ids_to_params(ids).each do |pid|
+            fail Error, "The '#{pid}' params is mandatory for this method" unless params.include?(pid)
+          end
+
+          method_with_ids = method.dup
+
+          # Replacing values
+          ids.each do |pid|
+            param_name = pid.split('-').first
+            param_value = params[Client.id_to_param(pid)]
+            method_with_ids.map! do |v|
+              (v == pid) ? "#{param_name}/#{param_value}" : v
+            end
+          end
+
+          uri = '/'
+          uri += method_with_ids.join('/')
+          send(verb, uri, params)
+        end
+      end
+    end
+
     API_METHODS_MAP.each do |api_method|
       if api_method.is_a?(Array)
         friendly_method = api_method.first
@@ -18,15 +66,18 @@ module Primotexto
       method = api_method.split('_')
       with_params = api_method.include?('params')
       method.pop if with_params
+
+      ids = method.select { |i| i.include?('-id') }
+
       friendly_method = method.join('_') if friendly_method.nil?
       verb = method.shift
       uri = '/'
       uri += method.join('/')
 
       if with_params
-        behaviour = -> (params) { send(verb, uri, params) }
+        behaviour = (ids.any?) ? params_with_ids_behaviour(verb, method, ids) : params_behaviour(verb, uri)
       else
-        behaviour = -> { send(verb, uri) }
+        behaviour = no_params_behaviour(verb, uri)
       end
       define_method(friendly_method.to_sym, &behaviour)
     end

data/lib/primotexto/version.rb

@@ -1,3 +1,3 @@
 module Primotexto
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/primotexto.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["synthax.terror@gmail.com"]
 
   spec.summary       = %q{Ruby client for the Primotexto API}
-  spec.description   = %q{Send SMS easily}
+  spec.description   = %q{An unofficial Ruby client for the Primotexto API}
   spec.homepage      = "https://github.com/syntaxTerr0r/primotexto"
   spec.license       = "MIT"
 
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport", ">= 2.2.1"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: primotexto
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sébastien Poudat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-03-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Send SMS easily
+description: An unofficial Ruby client for the Primotexto API
 email:
 - synthax.terror@gmail.com
 executables: []