bolzter 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmJjZTk0MGI4MmUzNTNiNjMwMTgxY2EyODFiZjA0YzRiOGEyOTc1MA==
+  data.tar.gz: !binary |-
+    Y2EwNTAwZDA0YTk5MmFjMTVmYjhlOWU0YTVkYjE0YTI1ZDQ3NzM5MA==
+SHA512:
+  metadata.gz: !binary |-
+    Zjc1ZDA1NTRlODUyNmEzZGRiM2NlMmRiMGI4ZWQwNTE2ZDI2M2EwMDExYzEw
+    ZGRlZTMzMTc1YmY0YTUwMjY3ODVkY2VlMjhmM2U0MGU4ZWI2Y2M3YjZlZDhl
+    MjdlNTE1MGI5OTg4NmVhNjFlYjcxNzc2MzEyZWRiYTMwMDYyNzI=
+  data.tar.gz: !binary |-
+    OWYzNTQwYmJhZGMwNGZkYjZmNzRlMmQ2MzY0MjhlMmY4M2IwOWVkNmY5MDQx
+    MmEzNDNlYjQ5OGUxNGU5MTQzNTQ0MzhkNzUyMGM5Y2JlYzI0YTZkN2RjNzdj
+    NWIzNjQyMWFkOTFmZWY0OGUxZWY2NDdiNzY3OGVmZmZmZWM2NmE=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John
+
+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,119 @@
+# Bolzter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bolzter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bolzter
+
+## Usage
+
+###1. Setting API key
+
+```ruby
+Bolzter::Bolzter.set_credentials("YOUR_USERNAME", "YOUR_API_KEY")
+```
+
+Output
+
+```ruby
+=> {:username=>"YOUR_USERNAME", :api_key=>"YOUR_API_KEY"}
+```
+
+
+###2. Getting users
+
+```ruby
+$ Bolzter::Bolzter.users
+```
+
+Output
+
+```ruby
+$ => {"meta"=>{"limit"=>20, "next"=>nil, "offset"=>0, "previous"=>nil, "total_count"=>1}, "objects"=>[{"email"=>"user@example.com", "first_name"=>"Test", "id"=>12, "last_login"=>"2014-07-14T12:15:22", "last_name"=>"User", "resource_uri"=>"/api/v2.1/user/12/"}]}
+```
+
+###3. Getting a user
+
+```ruby
+Bolzter::Bolzter.user(id)
+```
+
+###4. Getting campaigns
+
+```ruby
+Bolzter::Bolzter.campaigns
+```
+
+###5. Getting a campaign
+
+```ruby
+Bolzter::Bolzter.campaign
+```
+
+###6. Getting persons
+
+```ruby
+Bolzter::Bolzter.persons
+```
+
+###7. Getting a person
+
+```ruby
+Bolzter::Bolzter.person(id)
+```
+
+###8. Updating a person
+
+```ruby
+params = {
+			"first_name" 	=> "NewFName",
+			"last_name" 	=> "NewLName",
+			...
+		}
+Bolzter::Bolzter.update_person(id, params)
+```
+
+###9. Deleting a person
+
+```ruby
+Bolzter::Bolzter.delete_person(id)
+```
+
+###10. Creating a lead
+
+```ruby
+params = {
+			"first_name" 	=> "fName",
+			"last_name" 	=> "lName",
+			"email"			=> "fname.lname@example.com",
+			"campaign"		=> campaign_id,	# Or campaign resource. For example /api/v2.1/campaign/42/
+			...
+		}
+Bolzter::Bolzter.create_lead(params)
+```
+
+Output:
+
+	$=> #<Net::HTTPCreated 201 CREATED readbody=true>
+
+
+## Contributing
+
+1. Fork it ( https://github.com/rails-webmaster/bolzter/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,2 @@
+require "bundler/gem_tasks"
+

data/bolzter.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bolzter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bolzter"
+  spec.version       = Bolzter::VERSION
+  spec.authors       = ["John"]
+  spec.email         = ["rails.john.smith@gmail.com"]
+  spec.summary       = "This gem supports an interface to Bolzter APIs"
+  spec.description   = "This gem supports an interface to Bolzter APIs"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = ["Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bolzter.gemspec", "lib/bolzter.rb", "lib/bolzter/version.rb"]
+  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"
+end

data/lib/bolzter/version.rb

@@ -0,0 +1,3 @@
+module Bolzter
+  VERSION = "0.0.2"
+end

data/lib/bolzter.rb

@@ -0,0 +1,201 @@
+require "bolzter/version"
+require 'uri'
+require 'net/http'
+require 'json'
+require 'yaml'
+
+module Bolzter
+	class Bolzter
+		# Class level variables
+		@@api_root = "https://social.bolzter.com/api/v2.1/"
+		@@username = ""
+		@@api_key = ""
+		@@end_point = "user"
+
+		# => Set credential. It should be called before call APIs.
+		def self.set_credentials(username, api_key)
+			@@username = username
+			@@api_key = api_key
+			{:username => username, :api_key => api_key}
+		end
+
+		def self.set_credentials
+			conf_file = File.join(Rails.root, 'config', 'bolzter.yml').to_s
+			if File.exists?(conf_file)
+				config = YAML.load_file(conf_file)
+				self.set_credentials(config["username"], config["api_key"])
+			else
+				puts "conf/bolzter.yml file does not exist. Please copy bolzter.yml.example file."
+			end
+		end
+
+		# => Creating uri path
+		def self.make_uri(end_point)
+
+			@@api_root + end_point + "/?username=" + @@username + "&api_key=" + @@api_key
+		end
+
+		# => Getting api root uri
+		def self.api_root
+
+			@@api_root
+		end
+
+		# => Getting username. It will be email address.
+		def self.username
+
+			@@username
+		end
+
+		# => Getting api_key. It can be found in your Bolzter account page.
+		def self.api_key
+
+			@@api_key
+		end
+
+		# => Getting all users
+		# => A list of your users, actually there is 1 user in the list (id, first_name, last_name, email, last_login).
+		def self.users
+			uri = URI.parse(make_uri("user"))
+			Net::HTTP.start(uri.host, uri.port,
+							:use_ssl => uri.scheme == 'https', 
+							:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Get.new uri.request_uri
+
+				@response = http.request request # Net::HTTPResponse object
+			end
+
+			JSON.parse @response.body
+		end
+
+		# => Getting a user from user Identity
+		# => A list of your users, actually there is 1 user in the list (id, first_name, last_name, email, last_login).
+		def self.user id
+			uri = URI.parse(make_uri("user/" + id.to_s))
+			Net::HTTP.start(uri.host, uri.port,
+							:use_ssl => uri.scheme == 'https', 
+							:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Get.new uri.request_uri
+
+				@response = http.request request # Net::HTTPResponse object
+			end
+
+			JSON.parse @response.body
+		end
+
+		# => Campaign resources of a user.
+		# => Response: List of campaigns of a user (id, name, description, start_date, end_date, status).
+		def self.campaigns
+			uri = URI.parse(make_uri("campaign"))
+			Net::HTTP.start(uri.host, uri.port,
+							:use_ssl => uri.scheme == 'https', 
+							:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Get.new uri.request_uri
+
+				@response = http.request request # Net::HTTPResponse object
+			end
+
+			JSON.parse @response.body
+		end
+
+		# => Response: Properties of a campaign object identified by {id} (id, name, description, start_date, end_date, status).
+		def self.campaign id
+			uri = URI.parse(make_uri("campaign/" + id.to_s))
+			Net::HTTP.start(uri.host, uri.port,
+							:use_ssl => uri.scheme == 'https', 
+							:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Get.new uri.request_uri
+
+				@response = http.request request # Net::HTTPResponse object
+			end
+
+			JSON.parse @response.body
+		end
+
+		# => Person resources of a user.
+		# => Response: List of person belongs to the user's campaigns (id, first_name, last_name, email, birthday, gender, phone, converted).
+		def self.persons
+			uri = URI.parse(make_uri("person"))
+			Net::HTTP.start(uri.host, uri.port,
+							:use_ssl => uri.scheme == 'https', 
+							:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Get.new uri.request_uri
+
+				@response = http.request request # Net::HTTPResponse object
+			end
+
+			JSON.parse @response.body
+		end
+
+		# => Response: Properties of a person object identified by {id} (id, first_name, last_name, email, birthday, gender, phone, converted).
+		def self.person id
+			uri = URI.parse(make_uri("person/" + id.to_s))
+			Net::HTTP.start(uri.host, uri.port,
+							:use_ssl => uri.scheme == 'https', 
+							:verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Get.new uri.request_uri
+
+				@response = http.request request # Net::HTTPResponse object
+			end
+
+			JSON.parse @response.body
+		end
+
+		# => Response: Properties of a person object identified by {id} (id, first_name, last_name, email, birthday, gender, phone, converted).
+		# => Request: The required changes must be in JSON encoded format and don't forget to set the content type to 'application/json' (eg. {“converted”: true}).
+		# => Response: The proper HTTP code according to the success of the request.
+		def self.update_person(id, params)
+			uri = URI.parse(make_uri("person/" + id.to_s))
+			Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https', :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Patch.new(uri.request_uri)
+				request.add_field('Content-Type', 'application/json')
+				request.body = JSON.dump(params)
+
+				@response = http.request request
+			end
+		end
+
+		# => Response: The proper HTTP status code.
+		def self.delete_person(id)
+			uri = URI.parse(make_uri("person/" + id.to_s))
+			Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https', :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Delete.new(uri.request_uri)
+
+				@response = http.request request
+			end
+		end
+
+		# => Creating Person object and register it for the appropriate Campaign in one step.
+		# => Field name				Required			Description
+		# => first_name					yes			First name in max. 75 length
+		# => last_name					yes			Last name in max. 75 length
+		# => email						yes			Valid email address in max. 100 length
+		# => campaign					yes			Campaign resource identifier which can be a numeric ID or a resource URI (eg. /api/v2.1/campaign/42/)
+		# => phone						no			Phone number in max. 100 length
+		# => birthday					no			Birthday in form YYYY-MM-DD
+		# => country					no			Country name according to ISO-3166 in max. 50 length
+		# => state						no			State of the country in max. 50 length
+		# => city						no			City name in max. 100 length
+		# => facebook_access_token		no			Valid Facebook User Access Token which is given by the user. Pay attention that the FB App which requested the permission must be the same as set for the campaign in Bolzter.
+		# => tracking_cookie			no			For such cases when the user's activities are tracked in browsers and the registration process is not going through a web page but the API. In order to be able to associate this tracked history to the lead we need the tracking cookie (bolzter_premarker).
+		def self.create_lead(params)
+			uri = URI.parse(make_uri("lead"))
+			Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https', :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |http|
+
+				request = Net::HTTP::Post.new(uri.request_uri)
+				request.add_field('Content-Type', 'application/json')
+				request.body = JSON.dump(params)
+
+				@response = http.request request
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: bolzter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 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'
+description: This gem supports an interface to Bolzter APIs
+email:
+- rails.john.smith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bolzter.gemspec
+- lib/bolzter.rb
+- lib/bolzter/version.rb
+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.4
+signing_key: 
+specification_version: 4
+summary: This gem supports an interface to Bolzter APIs
+test_files: []