benchmark_email_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e85f43b789596a2bbf80c76eb277fdd6f22d1cc1
+  data.tar.gz: ac827b50097bd804c229616cc2de488d8834f5e8
+SHA512:
+  metadata.gz: 4b1acf25e965a8e20fec581869499e94a6bbb3e5c95b5267ec975c42e8cdfc5443776fe0366b9cb8d0a1f317e7f30f05bf6e4feac812c7987d7a84a27adbe626
+  data.tar.gz: e7588a8bbba08b45af0fa8ff48bcee2a5cb3414c50260cf504c2449836e31d9fc047dda883afc72cbf0661294035d21f84e38ce843cff28a6937b5ec1cfc3a8b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in benchmark_email_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 resj
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# BenchmarkEmailApi
+
+This is a Gem built to use the ruby wrapper for Benchmark Email marketing. It has two main methods: one method creates a client object using the Benchmark credentials, the other is a method_missing. The methods you can call are documented in Benchmark's API docs.
+
+[http://www.benchmarkemail.com/API/Library]
+
+The parameters are the same minus the token ( always the first one to be passed according to the docs) because the client object already has it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'benchmark_email_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benchmark_email_api
+
+## Usage
+
+## Instantiate a **Client** object.
+
+```ruby
+BMEApi = BenchmarkEmialApi::Client.new(username,password, api_url)
+```
+
+
+The Api Url is usually a constant: *'http://api.benchmarkemail.com/1.0/'*.
+
+All parameters for the client instantiation are **strings**.
+
+## Call the methods on the api docs.
+
+```ruby
+BMEApi.listsGet
+```
+
+This is a lists method that will be sent to the Benchmark Api throught the Client.
+
+```ruby
+BMEApi.batchAddContacts(list_id, contacts)
+```
+
+Notice how we didn't need to pass the token as the docs suggested: [http://www.benchmarkemail.com/API/Doc/batchAddContacts]
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/benchmark_email_api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/benchmark_email_api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmark_email_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benchmark_email_api"
+  spec.version       = BenchmarkEmailApi::VERSION
+  spec.authors       = ["resj"]
+  spec.email         = ["raymons17@gmail.com"]
+  spec.summary       = ['Deal with the Benchmark email api.']
+  spec.description   = ['Methods to access the benchmark API over XML RPC.']
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/benchmark_email_api.rb

@@ -0,0 +1,24 @@
+# require "benchmark_email_api/version"
+require "net/http"
+require "net/https"
+require "openssl"
+require "xmlrpc/client"
+
+module BenchmarkEmailApi
+  class Client
+    def initialize(username,password,api_url)
+      @server = XMLRPC::Client.new2(api_url)
+      $ok, result = @server.call2('login', username, password)
+      if $ok
+        @token = result
+      else
+        puts "Error Code: #{result.faultCode}"
+        puts "Error Description: #{result.faultString}"
+      end
+     end
+     def method_missing(api_method, *args)
+      $ok, result = @server.call2(api_method.to_s, @token, *args)
+      return result
+     end
+  end
+end

data/lib/benchmark_email_api/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkEmailApi
+  VERSION = "0.0.1"
+end

data/spec/benchmark_email_api_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe BenchmarkEmailApi do
+
+  it 'makes a connection with the api' do
+    bm = BenchmarkEmailApi.new(username,password,apikey)
+    expect(bm.token).to eq (true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'benchmark_email_api'

data/spec/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_email_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- resj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '["Methods to access the benchmark API over XML RPC."]'
+email:
+- raymons17@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark_email_api.gemspec
+- lib/benchmark_email_api.rb
+- lib/benchmark_email_api/version.rb
+- spec/.DS_Store
+- spec/benchmark_email_api_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/.DS_Store
+- spec/tasks/rspec.rake
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: '["Deal with the Benchmark email api."]'
+test_files:
+- spec/.DS_Store
+- spec/benchmark_email_api_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/.DS_Store
+- spec/tasks/rspec.rake