mogreet 0.0.1 → 0.0.2.pre

data/.gitignore

@@ -1,14 +1,9 @@
 *.gem
 *.rbc
 .bundle
-.rvmrc
 .config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
 coverage
-doc/
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc
@@ -16,3 +11,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/README.md

@@ -1,29 +1,50 @@
-# Mogreet
+Mogreet API 
+===========
+
+Examples assume that your credentials are set via config vars (https://devcenter.heroku.com/articles/config-vars). 
+
+__Ping__
+    
+    client   = Mogreet::Client.new(ENV['MOGREET_CLIENT_ID'], ENV['MOGREET_TOKEN'])
+    response = client.system.ping
+    puts response.message
+    
+    
+__Send MMS to one recipient__
+
+    client   = Mogreet::Client.new(ENV['MOGREET_CLIENT_ID'], ENV['MOGREET_TOKEN'])
+    response = client.transaction.send(
+      :campaign_id => ENV['MOGREET_MMS_CAMPAIGN_ID'], 
+      :to          => '1111111111', 
+      :message     => 'hello world', 
+      :content_url => 'https://wp-uploads.mogreet.com/wp-uploads/2013/02/API-Beer-sticker-300dpi-1024x1024.jpg'
+    )
+
+__Send SMS to one recipient__
+
+    client   = Mogreet::Client.new(ENV['MOGREET_CLIENT_ID'], ENV['MOGREET_TOKEN'])
+    response = client.transaction.send(
+      :campaign_id => ENV['MOGREET_SMS_CAMPAIGN_ID'], 
+      :to          => '1111111111', 
+      :message     => 'hello world'
+    )
+
+__Send SMS to list of recipients__
+    
+    client   = Mogreet::Client.new(ENV['MOGREET_CLIENT_ID'], ENV['MOGREET_TOKEN'])
+    response = client.list.send(
+      :campaign_id => ENV['MOGREET_SMS_CAMPAIGN_ID'], 
+      :message     => 'hello world',
+      :list_id     => '8228'
+    )
+
+
+__Upload File__
+    
+    client   = Mogreet::Client.new(ENV['MOGREET_CLIENT_ID'], ENV['MOGREET_TOKEN'])
+    response = client.media.upload(
+      :name => 'upload name', 
+      :type => 'image', 
+      :file => File.new("image.jpg")
+    )
 
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'mogreet'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install mogreet
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/Rakefile

@@ -1,5 +1,10 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new('spec')
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/lib/mogreet.rb

@@ -1,9 +1,13 @@
-require 'hashie'
-require 'httparty'
-require 'crack/xml'
 
-require "mogreet/mogreet"
-require "mogreet/version"
-require "mogreet/config"
-require "mogreet/message"
-require "mogreet/response/transaction_send"
+
+require 'mogreet/client'
+require 'mogreet/response'
+require 'mogreet/request'
+require 'mogreet/system'
+require 'mogreet/transaction'
+require 'mogreet/user'
+require 'mogreet/keyword'
+require 'mogreet/list'
+require 'mogreet/media'
+require 'mogreet/deprecated'
+require 'mogreet/version'

data/lib/mogreet/client.rb

@@ -0,0 +1,60 @@
+require 'rest_client'
+require 'hashie'
+require 'json'
+
+module Mogreet
+  class Client
+    # include Request
+    
+    attr_accessor :client_id, :token, :http_response
+
+    def initialize(client_id, token)
+      @client_id = client_id
+      @token     = token
+    end
+        
+    def get_request(path, query_params = {})
+      params = default_api_args.merge(query_params)
+      @http_response = RestClient.get("https://api.mogreet.com#{path}", {:params => params})
+      Response.new(JSON.parse(@http_response.body)).response
+    end
+    
+    def post_request(path, query_params = {})
+      params = default_api_args.merge(query_params)
+      @http_response = RestClient.post("https://api.mogreet.com#{path}", params)
+      Response.new(JSON.parse(@http_response.body)).response
+    end
+    
+    def list
+      @list ||= List.new(self)
+    end
+
+    def user
+      @user ||= User.new(self)
+    end
+
+    def media
+      @media ||= Media.new(self)
+    end
+
+    def system
+      @system ||= System.new(self)
+    end
+    
+    def keyword
+      @keyword ||= Keyword.new(self)
+    end
+
+    def transaction
+      @transaction ||= Transaction.new(self)      
+    end
+
+    private
+    
+    def default_api_args
+      {:client_id => @client_id, :token => @token, :format => 'json'}
+    end
+    
+  end
+  
+end

data/lib/mogreet/deprecated.rb

@@ -0,0 +1,56 @@
+require 'hashie'
+
+module Mogreet
+  class Config < Hashie::Mash ; end
+
+  def self.config
+     @@config ||= Config.new
+   end
+
+   def self.configure
+     @@config = Config.new
+     yield config
+   end
+
+  class Response
+    class TransactionSend < Hashie::Mash
+      def transaction_hash
+        self[:hash]
+      end
+    end
+  end
+
+  class Message
+    class << self
+      def send(options)
+        params = Mogreet.config.merge(options).merge(:format => :json)
+        response = RestClient.get("https://api.mogreet.com/moms/transaction.send", {:params => params.to_hash})
+        Mogreet::Response::TransactionSend.new(JSON.parse(response.body)).response
+      end
+    end
+  end
+end
+
+
+# - "{\"client_id\"=>\"714\", \"token\"=>\"a48951eed1e8b093fbea70d882257d84\", \"campaign_id\"=>\"20861\", \"to\"=>\"3104656416\", \"message\"=>\"Hello World!\", \"content_url\"=>\"http://rubyonrails.org/images/rails.png\", \"format\"=>:json}"
+
+# Configuration
+# Configure mogreet (add this block to config/initializers/mogreet.rb in case of Rails application):
+# 
+# Mogreet.configure do |config|
+#   config.client_id   = "123"
+#   config.token       = "ee91dfa14e59a8600d7976c554f2ed12"
+#   config.campaign_id = "19001"
+# end
+# Usage
+# Send MMS message:
+# 
+# response = Mogreet::Message.send to: '5551236789',
+#                                  message: 'Hello World!',
+#                                  content_url: 'http://rubyonrails.org/images/rails.png'
+# 
+# response.status           #=> "success"
+# response.code             #=> "1"
+# response.message          #=> "Mogreet successfully sent!"
+# response.message_id       #=> 123456789
+# response.transaction_hash #=> "a12b3c4d"

data/lib/mogreet/keyword.rb

@@ -0,0 +1,27 @@
+module Mogreet
+  class Keyword
+    def initialize(client)
+      @client = client
+    end
+
+    def list(options ={})
+      @client.get_request('/cm/keyword.list', options)
+    end
+    
+    def check(options)
+      @client.get_request('/cm/keyword.check', options)
+    end
+    
+    # campaign_id
+    # keyword
+    def add(options)
+      @client.get_request('/cm/keyword.add', options)
+    end
+    
+    # campaign_id
+    # keyword
+    def remove(options)
+      @client.get_request('/cm/keyword.remove', options)
+    end
+  end
+end

data/lib/mogreet/list.rb

@@ -0,0 +1,67 @@
+module Mogreet
+  class List  
+    def initialize(client)
+      @client = client
+    end
+    
+    def list(options ={})
+      @client.get_request('/cm/list.list', options)      
+    end
+
+    def info(options ={})
+      @client.get_request('/cm/list.info', options)      
+    end
+
+    # name
+    def create(options ={})
+      @client.get_request('/cm/list.create', options)      
+    end
+
+    # list_id
+    # numbers
+    def append(options ={})
+      # TODO clone options?
+      options[:numbers] = options[:numbers].join(',') if options[:numbers].is_a?(Array)
+      @client.get_request('/cm/list.append', options)      
+    end
+
+    # list_id
+    # numbers
+    def prune(options ={})
+      # TODO clone options?
+      options[:numbers] = options[:numbers].join(',') if options[:numbers].is_a?(Array)
+      @client.get_request('/cm/list.prune', options)      
+    end
+
+    # list_id
+    # campaign_id
+    # subject
+    # message
+    # content_id
+    # content_url
+    # to_name
+    # from_name
+    def send(options)      
+      @client.get_request('/cm/list.send', options)
+    end
+    
+    # list_id
+    # format
+    def download(options)
+      @client.get_request('/cm/list.download', options)
+    end
+
+    # list_id
+    # name
+    def empty(options)
+      @client.get_request('/cm/list.empty', options)
+    end
+
+    # list_id
+    # name
+    def destroy(options)
+      @client.get_request('/cm/list.destroy', options)
+    end
+
+  end
+end

data/lib/mogreet/media.rb

@@ -0,0 +1,19 @@
+module Mogreet
+  class Media
+    def initialize(client)
+      @client = client
+    end
+    def list(options = {})
+      @client.get_request('/cm/media.list')
+    end    
+    
+    def upload(options)
+      @client.post_request('/cm/media.upload', options)
+    end
+
+    def destroy(options)
+      @client.get_request('/cm/media.destroy', options)
+    end
+    
+  end
+end

data/lib/mogreet/request.rb

@@ -0,0 +1,19 @@
+module Mogreet
+  module Request
+    def get_request(path, query_params = {})
+      params = default_api_args.merge(query_params)
+      @http_response = RestClient.get("https://api.mogreet.com#{path}", {:params => params})
+      Response.new(JSON.parse(@http_response.body)).response
+    end
+    
+    def post_request(path, query_params = {})
+      params = default_api_args.merge(query_params)
+      @http_response = RestClient.post("https://api.mogreet.com#{path}", params)
+      Response.new(JSON.parse(@http_response.body)).response
+    end
+    
+    def default_api_args
+      {:client_id => @client_id, :token => @token, :format => 'json'}
+    end
+  end  
+end

data/lib/mogreet/response.rb

@@ -0,0 +1,7 @@
+module Mogreet
+  class Response < Hashie::Mash
+    def hash
+      self[:hash]      
+    end
+  end
+end

data/lib/mogreet/system.rb

@@ -0,0 +1,10 @@
+module Mogreet
+  class System
+    def initialize(client)
+      @client = client
+    end
+    def ping(options = {})
+      @client.get_request('/moms/system.ping')      
+    end    
+  end
+end

data/lib/mogreet/transaction.rb

@@ -0,0 +1,30 @@
+module Mogreet
+  class Transaction
+    def initialize(client)
+      @client = client
+    end
+
+    ##
+    # campaign_id:  An ID connected to a specific campaign 
+    # to:           The mobile number (MSISDN) of the handset you would like to send to.
+    # from:         The mobile number (MSISDN) of the handset you would like to send from. Or the shortcode associated with the campaign. (Optional – if not included, this parameter will default to the shortcode associated to the campaign).
+    # message:      The message presented to the "to" user.
+    # content_id:   An integer value associated to a piece of content ingested through the Campaign Manager or API.
+    # content_url:  A publicly accessible URL of an image, audio or video. MOMS will automagically ingest the content and deliver it as specified by the campaign flow. (Optional, used for SMS and MMS delivering audio, image or video)
+    # callback:     If provided with a valid URL, any errors with the transaction will be sent to this URL via XML over HTTP. See description below.  
+    def send(options)
+      @client.get_request('/moms/transaction.send', options)      
+    end
+  
+    # client_id Your  client  id. Log onto  the Campaign  Manager to  access  your  client  id.
+    # token Your  token.  Log onto  the Campaign  Manager to  access  your  token.
+    # message_id A  unique  ID  returned  from  a successful  transaction.send  request or  from  
+    # user.transactions method.
+    # hash A  hash  returned  from  a successful  transaction.send  request or  from  a 
+    # user.transactions method.
+    def lookup(options)
+      # q6z5e0on
+      @client.get_request('/moms/transaction.lookup', options)      
+    end
+  end
+end