phplist 0.1.0

data/Manifest

@@ -0,0 +1,7 @@
+CHANGELOG
+README.md
+README.rdoc
+Rakefile
+lib/phplist.rb
+phplist.gemspec
+Manifest

data/README.md

@@ -0,0 +1,48 @@
+# phplist
+
+Api for phplist to subscribe to phplist.
+
+## Installation
+
+    $ gem install phplist
+    
+## Requirements
+
+    1 - :domain => 'mailer.example.com' # Your Phplist domain url
+    2 - :action => 'LCsub.php' # Your action php file
+    3 - :password => 'xxxxxx' # Your phplist password which you have mentioned in LCsub.php
+    4 - :ssl_enabled => false # Is ssl_enabled or not
+
+Setup LCsub.php in your phplist project. (Download LCsub.php webservice from here.[LCsub.php](https://github.com/ahmadhussain/phplist_webservice))
+## Usage
+
+You can use this by creating an instance:
+
+    phplist = Phplist::API.new({:domain => 'mailer.example.com', :action => 'LCsub.php', :password => 'xxxxxx', :ssl_enabled => false})
+    
+You could set the values in an initializer file in your app (e.g. your_app_path/config/initializers/phplist.rb).
+
+    Phplist::API.domain = 'mailer.example.com'
+    Phplist::API.action = 'LCsub.php'
+    Phplist::API.password = 'xxxxxx'
+    Phplist::API.ssl_enabled = false
+    
+If you have added in initializer then you don't need to pass this as function parameters.
+ 
+    phplist = Phplist::API.new
+    
+### Subscribe User to a list:
+ 
+    phplist.subscribe({:id => list_id, :subscriber => {:email => 'name@email.com'}})
+    
+    
+### Subscribe a batch of users:
+
+    phplist.subscribe_list({:id => list_id, :subscribers => [{:email => 'name1@email.com'}, {:email => 'name2@email.com'}]})
+    
+### Subscribe multiple details:
+
+You can also subscribe multiple details like name, city, country:
+
+    phplist.subscribe({:id => list_id, :subscriber => {:email => 'name@email.com', :name => 'name', :city => 'city', :country => 'country'}})
+    phplist.subscribe_list({:id => list_id, :subscribers => [{:email => 'name@email.com', :name => 'name', :city => 'city', :country => 'country'}, {:email => 'name2@email.com', :name => 'name2', :city => 'city2', :country => 'country2'}]})

data/README.rdoc

@@ -0,0 +1,47 @@
+# phplist
+
+Api for phplist to subscribe to phplist.
+
+## Installation
+
+    $ gem install phplist
+    
+## Requirements
+
+    1 - :domain => 'mailer.example.com' # Your Phplist domain url
+    2 - :action => 'LCsub.php' # Your action php file
+    3 - :password => 'xxxxxx' # Your phplist password which you have mentioned in LCsub.php
+    4 - :ssl_enabled => false # Is ssl_enabled or not 
+    5 - Setup LCsub.php in your phplist project. (Download LCsub.php webservice from here.[LCsub.php](https://github.com/ahmadhussain/phplist_webservice))
+## Usage
+
+You can use this by creating an instance:
+
+    phplist = Phplist::API.new({:domain => 'mailer.example.com', :action => 'LCsub.php', :password => 'xxxxxx', :ssl_enabled => false})
+    
+You could set the values in an initializer file in your app (e.g. your_app_path/config/initializers/phplist.rb).
+
+    Phplist::API.domain = 'mailer.example.com'
+    Phplist::API.action = 'LCsub.php'
+    Phplist::API.password = 'xxxxxx'
+    Phplist::API.ssl_enabled = false
+    
+If you have added in initializer then you don't need to pass this as function parameters.
+ 
+    phplist = Phplist::API.new
+    
+### Subscribe User to a list:
+ 
+    phplist.subscribe({:id => list_id, :subscriber => {:email => 'name@email.com'}})
+    
+    
+### Subscribe a batch of users:
+
+    phplist.subscribe_list({:id => list_id, :subscribers => [{:email => 'name1@email.com'}, {:email => 'name2@email.com'}]})
+    
+### Subscribe multiple details:
+
+You can also subscribe multiple details like name, city, country:
+
+    phplist.subscribe({:id => list_id, :subscriber => {:email => 'name@email.com', :name => 'name', :city => 'city', :country => 'country'}})
+    phplist.subscribe_list({:id => list_id, :subscribers => [{:email => 'name@email.com', :name => 'name', :city => 'city', :country => 'country'}, {:email => 'name2@email.com', :name => 'name2', :city => 'city2', :country => 'country2'}]})

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('phplist', '0.1.0') do |p|
+  p.description    = "Phplist subscriber"
+  p.url            = "http://github.com/ahmadhussain/phplist"
+  p.author         = "Ahmad Hussain"
+  p.email          = "ahmadhmugl@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/phplist.rb

@@ -0,0 +1,56 @@
+require 'net/http'
+require 'uri'
+
+module Phplist
+  class API
+
+    attr_accessor :domain, :action, :password, :ssl_enabled
+    def initialize(default_parameters = {:domain => nil, :action => nil, :password => nil, :ssl_enabled => false})
+      @domain = default_parameters[:domain]||self.class.domain
+      @action = default_parameters[:action]||self.class.action
+      @password = default_parameters[:password]||self.class.password
+      @ssl_enabled = default_parameters[:ssl_enabled]||self.class.ssl_enabled
+    end
+
+    def subscribe(info = {:id => nil, :subscriber => {:email => nil, :name => nil, :city => nil, :country => nil}})
+      return false if info[:id].blank?
+      return false if info[:subscriber].blank? || info[:subscriber][:email].blank?
+      p_email = info[:subscriber][:email]
+      name = info[:subscriber][:name]
+      p_name = CGI::escape(name||'')
+
+      p_city = CGI::escape(info[:subscriber][:city]||'')
+      p_country = CGI::escape(info[:subscriber][:country]||'')
+
+      start_time = Time.now
+      url = "http#{'s' if @ssl_enabled}://#{@domain}/#{@action}?password=#{@password}&email=#{p_email.downcase}&name=#{p_name}&city=#{p_city}&country=#{p_country}&makeconfirmed=1&lid=#{info[:id]}"
+      url = URI.encode(url)
+      uri = URI(url)
+      res = Net::HTTP.get_response(uri)
+      response_str = res.body.to_s
+      if /success/i =~ response_str
+      return true
+      end
+      return false
+    end
+
+    def subscribe_list(info = {:id => nil, :subscribers => [{:email => nil, :name => nil, :city => nil, :country => nil}]})
+      return false if info[:id].blank?
+      return false if info[:subscribers].blank?
+      subscribed = false
+      info[:subscribers].each do |subscriber|
+        subscribed = subscribe({:id => info[:id], :subscriber => subscriber})
+        return false unless subscribed
+      end
+      subscribed
+    end
+
+    class << self
+      attr_accessor :domain, :action, :password, :ssl_enabled
+      def method_missing(sym, *args, &block)
+        new({:domain => self.domain, :action => self.action, :password => self.password, :ssl_enabled => self.ssl_enabled}).send(sym, *args, &block)
+      end
+    end
+
+  end
+end

data/phplist.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "phplist"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ahmad Hussain"]
+  s.date = "2013-11-27"
+  s.description = "Phplist subscriber"
+  s.email = "ahmadhmugl@gmail.com"
+  s.extra_rdoc_files = ["CHANGELOG", "README.md", "README.rdoc", "lib/phplist.rb"]
+  s.files = ["CHANGELOG", "README.md", "README.rdoc", "Rakefile", "lib/phplist.rb", "phplist.gemspec", "Manifest"]
+  s.homepage = "http://github.com/ahmadhussain/phplist"
+  s.rdoc_options = ["--line-numbers", "--title", "Phplist", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "phplist"
+  s.rubygems_version = "1.8.25"
+  s.summary = "Phplist subscriber"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: phplist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ahmad Hussain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies: []
+description: Phplist subscriber
+email: ahmadhmugl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG
+- README.md
+- README.rdoc
+- lib/phplist.rb
+files:
+- CHANGELOG
+- README.md
+- README.rdoc
+- Rakefile
+- lib/phplist.rb
+- phplist.gemspec
+- Manifest
+homepage: http://github.com/ahmadhussain/phplist
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --title
+- Phplist
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: phplist
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Phplist subscriber
+test_files: []