little_sms 0.1.0 → 0.2.0

data/Gemfile

@@ -7,9 +7,9 @@ gem "json_pure"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+  gem "shoulda"
+  gem "bundler"
+  gem "jeweler"
+  gem "rcov"
 end
 

data/Gemfile.lock

@@ -15,8 +15,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  bundler
+  jeweler
   json_pure
   rcov
   shoulda

data/README.md

@@ -7,16 +7,26 @@ This gem provides access to LittleSMS.ru API from ruby.
 # Usage
     require "little_sms"
     api = LittleSMS.new(:apiuser, :apikey)
-    api.message.send(:recipients => "112", :message => "Sos!")
+    api.message.send(:recipients => "+79211234567", :message => "Test", :test => 1)
 
 Also you can pass a block to LittleSMS object:
 
     LittleSMS.new(:apiuser, :apikey) do
-      msg =  message.send(:recipients => "112", :message => "Sos!")
-      if msg[:status] == :success
-        messages_id = msg[:messages_id].join
+      msg =  message.send(:recipients => "+79211234567", :message => "Test")
+      if msg.success?
+        messages_id = msg.messages_id.join
         status = message.status(:messages_id => messages_id)
-        puts "Message #{status[:messages][messages_id]}" if status[:status] == :success
+        puts "Message #{status.messages[messages_id]}" unless status.error? # => Message delivered
+      end
+    end
+
+In case of error:
+
+    LittleSMS.new(:apiuser, :apikey) do
+      msg = message.send(:recipients => "112", :message => "Test")
+      if msg.error?
+        puts msg.error   # => 4
+        puts msg.message # => "incorrect or empty recipients list"
       end
     end
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/little_sms/component.rb

@@ -3,6 +3,7 @@ require "net/http"
 require "net/https"
 require 'digest/md5'
 require 'digest/sha1'
+require_relative "responce"
 
 class LittleSMS
   class Component
@@ -12,7 +13,7 @@ class LittleSMS
 
     def initialize(component, api_user, api_key)
       @api_uri = URI.parse("https://littlesms.ru:443/api/")
-      @auth = {:user => api_user, :key => api_key}
+      @api_user, @api_key = api_user, api_key
       @component = component # Component name. E.g. message or user.
     end
 
@@ -23,13 +24,10 @@ class LittleSMS
     private
     def request_api_method(method, options = {})
       options ||= {}
-      options.merge!(@auth)
-
-      # Replace original sort method
-      options.extend(self.class::Options)
-      options.method_path = {:method => method, :component => @component }
-
+      options = Hash[options.sort]
       options[:sign] = sign_request(options)
+      options[:user] = @api_user
+
       uri = @api_uri.merge("#{@component}/#{method}")
       req = Net::HTTP::Post.new(uri.path)
       req.set_form_data(options.delete_if {|k, v| k == :key})
@@ -44,32 +42,14 @@ class LittleSMS
 
       case res = res.start {|http| http.request(req) }
       when Net::HTTPSuccess, Net::HTTPRedirection
-        return format_output(JSON.parse(res.body))
+        return Responce.new(JSON.parse(res.body))
       else
         res.error!
       end
     end
 
     def sign_request(options)
-      Digest::MD5.hexdigest(
-          Digest::SHA1.hexdigest(options.sort.map {|e| e[1]}.join)
-        )
-    end
-
-    # Convert all strings keys to symbols
-    def format_output(hash)
-      format = lambda do |v|
-        if v.respond_to?(:map)
-          format_output(v)
-        else
-          v
-        end
-      end
-      if hash.kind_of? Hash
-        Hash[ hash.map { |k, v| [k.to_sym, format.call(v)] } ]
-      else
-        hash.map { |v| format.call(v) }
-      end
+      Digest::MD5.hexdigest(Digest::SHA1.hexdigest("#{@api_user}#{options.values.join}#{@api_key}"))
     end
   end
 end

data/lib/little_sms/enumerable.rb

@@ -0,0 +1,12 @@
+# Convert all keys to symbols
+module Enumerable
+  def recursive_symbolize_keys
+    symbolize = lambda { |v| v.respond_to?(:map) ? v.recursive_symbolize_keys : v }
+    if self.kind_of? Hash
+      Hash[ self.map { |k, v| [k.to_sym, symbolize.call(v)] } ]
+    else
+      self.map { |v| symbolize.call(v) }
+    end
+  end
+end
+

data/lib/little_sms/little_sms.rb

@@ -10,6 +10,7 @@ class LittleSMS
     @components = {}
     self.instance_eval &block if block_given?
   end
+
   def method_missing(name, *args)
     @components[name] ||= Component.new(name, @api_user, @api_key)
   end

data/lib/little_sms/responce.rb

@@ -0,0 +1,38 @@
+require_relative "enumerable"
+
+class LittleSMS
+  class Responce
+    def initialize(json)
+      @json = json.recursive_symbolize_keys
+    end
+
+    def success?
+      @json[:status] == "success"
+    end
+
+    def error?
+      @json[:status] == "error"
+    end
+
+    def error
+      if error? then @json[:error] else nil end
+    end
+
+    def message
+      if error? then @json[:message] else nil end
+    end
+
+    def method_missing(name, *args)
+      unless args.empty?
+        super
+      else
+        @json[name] || super
+      end
+    end
+
+    def respond_to?(method)
+      @json.has_key?(method) || super
+    end
+  end
+end
+

data/lib/little_sms.rb

@@ -1,7 +1,6 @@
 libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
-require "#{libdir}/little_sms/options"
 require "#{libdir}/little_sms/component"
 require "#{libdir}/little_sms/little_sms"
 

data/little_sms.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{little_sms}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Artyom Bolshakov"]
-  s.date = %q{2011-03-06}
+  s.date = %q{2011-07-06}
   s.description = %q{LittleSMS.ru API binding}
   s.email = %q{tweekane@gmail.com}
   s.extra_rdoc_files = [
@@ -25,51 +25,42 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/little_sms.rb",
     "lib/little_sms/component.rb",
+    "lib/little_sms/enumerable.rb",
     "lib/little_sms/little_sms.rb",
-    "lib/little_sms/options.rb",
-    "lib/little_sms/ordering/contact.yaml",
-    "lib/little_sms/ordering/message.yaml",
-    "lib/little_sms/ordering/tag.yaml",
-    "lib/little_sms/ordering/task.yaml",
-    "lib/little_sms/ordering/user.yaml",
+    "lib/little_sms/responce.rb",
     "little_sms.gemspec",
+    "test/auth.rb",
     "test/test_component.rb",
     "test/test_little_sms.rb",
-    "test/test_options.rb"
+    "test/test_responce.rb"
   ]
   s.homepage = %q{http://github.com/TweeKane/little_sms}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{LittleSMS.ru API binding}
-  s.test_files = [
-    "test/test_component.rb",
-    "test/test_little_sms.rb",
-    "test/test_options.rb"
-  ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<json_pure>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<json_pure>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<json_pure>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end
 end

data/test/auth.rb

@@ -0,0 +1,10 @@
+module Auth
+  def self.included(other)
+    other.class_eval do
+      def auth
+        [:"acc-4fe53b2b", :"OZkgGZ7g"]
+      end
+    end
+  end
+end
+

data/test/test_component.rb

@@ -1,25 +1,32 @@
 require 'test/unit'
 require 'shoulda'
-require 'lib/little_sms'
+require_relative '../lib/little_sms'
+require_relative "auth"
 
 class ComponentTest < Test::Unit::TestCase
+  include Auth
   context "A LittleSMS::Component" do
     def setup
-      @options = {:message=>"sos", :recipients=>"112", :user=>'free', :key=>'Jesus'}
-      @options.extend(LittleSMS::Component::Options)
-      @options.method_path = {:method => :send, :component => :message }
+      @api_user, @api_key = self.auth
+      @options = {:message=>"test", :recipients=>"+79213752462", :user=>@api_user, :key=>@api_key}
       @component = LittleSMS::Component.new(:message, "Christ", "Jesus")
     end
 
     should "should sign request" do
       sign = @component.method(:sign_request).call(@options)
-      assert_equal "9ee9ac110901dae9ee9f97fde09f3268", sign
+      assert_equal "b616ddc6d0e15aaa92ce79ca78806337", sign
     end
 
     should "format output" do
       out = {"recipients"=>["911", "112"], "messages_id"=>[], "count"=>1, "parts"=>1, "price"=>0.5, "balance"=>9, "test"=>1, "status"=>"success"}
       formatted = {:recipients=>["911", "112"], :messages_id=>[], :count=>1, :parts=>1, :price=>0.5, :balance=>9, :test=>1, :status=>"success"}
-      assert_equal formatted, @component.instance_eval("format_output(#{out})")
+      assert_equal formatted, out.recursive_symbolize_keys
+    end
+
+    should "return LittleSMS::Responce object" do
+      api = LittleSMS.new(@api_user, @api_key)
+      resp = api.message.send(:recipients => "+79213752462", :message => "Test", :test => "1")
+      assert_equal(resp.class, LittleSMS::Responce)
     end
   end
 end

data/test/test_little_sms.rb

@@ -1,12 +1,12 @@
 require 'test/unit'
 require 'shoulda'
-require 'lib/little_sms'
+require_relative '../lib/little_sms'
 
 class LittleSMSTest < Test::Unit::TestCase
+  include Auth
   context "A LittleSMS" do
     def setup
-      @api_user = :testapiuser
-      @api_key = :testapikeystring
+      @api_user, @api_key = self.auth
       @sms = LittleSMS.new @api_user, @api_key
     end
 
@@ -22,6 +22,12 @@ class LittleSMSTest < Test::Unit::TestCase
       end
       assert_equal(LittleSMS::Component, mes.class)
     end
+
+    should "send message" do
+      api = LittleSMS.new(@api_user, @api_key)
+      resp = api.message.send(:recipients => "+79213752462", :message => "Test", :test => "1")
+      assert_equal(resp.success?, true)
+    end
   end
 end
 

data/test/test_responce.rb

@@ -0,0 +1,55 @@
+require "test/unit"
+require "shoulda"
+require_relative "../lib/little_sms/responce"
+
+class ResponceTest < Test::Unit::TestCase
+  context "A Responce" do
+    def setup
+      @simple_json = {:foo => "bar"}
+      @resp = LittleSMS::Responce.new(@simple_json)
+    end
+
+    should "create new responce object" do
+      assert_equal(@resp.instance_eval { @json }, @simple_json)
+    end
+
+    should "success?" do
+      resp = LittleSMS::Responce.new({:status => "success"})
+      assert_equal(resp.success?, true)
+      assert_equal(resp.error?, false)
+    end
+
+    should "error?" do
+      resp = LittleSMS::Responce.new({:status => "error"})
+      assert_equal(resp.error?, true)
+      assert_equal(resp.success?, false)
+    end
+
+    should "return error code and message" do
+      responce_json = {:status => "error", :error => 2, :message => "invalid signature"}
+      resp = LittleSMS::Responce.new(responce_json)
+      assert_equal(resp.error, responce_json[:error])
+      assert_equal(resp.message, responce_json[:message])
+    end
+
+    should "map responce fields to methods" do
+      responce_json = {:recipients=>["79213752462"], :price=>0.5, :balance=>0, :test=>1}
+      resp = LittleSMS::Responce.new(responce_json)
+      assert_equal(resp.price, 0.5)
+      assert_equal(resp.balance, 0)
+    end
+
+    should "respond to mapped method" do
+      assert_respond_to(@resp, :foo)
+    end
+
+    should "raise error if unknown methods invoked" do
+      resp = LittleSMS::Responce.new({:foo => "foo"})
+      assert_raise NoMethodError do
+        resp.bar
+      end
+    end
+
+  end
+end
+

metadata

@@ -1,107 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: little_sms
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Artyom Bolshakov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-06 00:00:00 +03:00
+date: 2011-07-06 00:00:00.000000000 +04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &21494940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *21494940
+- !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &21485800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *21485800
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &21484880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *21484880
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &21483820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
-        version: 1.5.2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *21483820
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &21482980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *21482980
 description: LittleSMS.ru API binding
 email: tweekane@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
+files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -110,52 +83,41 @@ files:
 - VERSION
 - lib/little_sms.rb
 - lib/little_sms/component.rb
+- lib/little_sms/enumerable.rb
 - lib/little_sms/little_sms.rb
-- lib/little_sms/options.rb
-- lib/little_sms/ordering/contact.yaml
-- lib/little_sms/ordering/message.yaml
-- lib/little_sms/ordering/tag.yaml
-- lib/little_sms/ordering/task.yaml
-- lib/little_sms/ordering/user.yaml
+- lib/little_sms/responce.rb
 - little_sms.gemspec
+- test/auth.rb
 - test/test_component.rb
 - test/test_little_sms.rb
-- test/test_options.rb
+- test/test_responce.rb
 has_rdoc: true
 homepage: http://github.com/TweeKane/little_sms
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 423631933341830267
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: LittleSMS.ru API binding
-test_files: 
-- test/test_component.rb
-- test/test_little_sms.rb
-- test/test_options.rb
+test_files: []

data/lib/little_sms/options.rb

@@ -1,32 +0,0 @@
-require "yaml"
-
-class LittleSMS
-  class Component
-    # This module should be mixed with request options hash.
-    #   to overwite Hash#sort method
-    module Options
-      class NoMethodError < StandardError; end
-      class NoComponentError < StandardError; end
-      attr_accessor :method_path
-      def sort
-        order = load_order(@method_path[:component], @method_path[:method])
-        self.to_a.sort do |a,b|
-          order.find_index(a[0]) <=> order.find_index(b[0])
-        end
-      end
-
-      private
-      # load sorting order from yaml file
-      def load_order(component, method)
-        begin
-          order = YAML.load_file("#{File.dirname(__FILE__)}/ordering/#{component}.yaml")[method]
-          raise NoMethodError, "There is no such method in #{component} file: #{method}" if order.nil?
-          order
-        rescue Errno::ENOENT
-          raise NoComponentError, "There is no such file: #{component}"
-        end
-      end
-    end
-  end
-end
-

data/lib/little_sms/ordering/contact.yaml

@@ -1,20 +0,0 @@
----
-:list:
-- :user
-- :key
-:create:
-- :user
-- :phone
-- :name
-- :description
-- :tags
-- :key
-:update:
-- :user
-- :id
-- :key
-:delete:
-- :user
-- :id
-- :key
-

data/lib/little_sms/ordering/message.yaml

@@ -1,32 +0,0 @@
----
-:send:
-- :user
-- :recipients
-- :message
-- :sender
-- :test
-- :sign
-- :key
-:status:
-- :user
-- :sign
-- :messages_id
-- :key
-:price:
-- :user
-- :sign
-- :recipients
-- :message
-- :key
-:history:
-- :user
-- :sign
-- :history_id
-- :recipient
-- :sender
-- :status
-- :date_from
-- :date_to
-- :id
-- :key
-

data/lib/little_sms/ordering/tag.yaml

@@ -1,9 +0,0 @@
----
-:list:
-- :user
-- :key
-:delete:
-- :user
-- :id
-- :key
-

data/lib/little_sms/ordering/task.yaml

@@ -1,6 +0,0 @@
----
-:delete:
-- :user
-- :id
-- :key
-

data/lib/little_sms/ordering/user.yaml

@@ -1,6 +0,0 @@
----
-:balance:
-- :user
-- :sign
-- :key
-

data/test/test_options.rb

@@ -1,37 +0,0 @@
-require 'test/unit'
-require 'shoulda'
-require 'lib/little_sms'
-
-class OptionsTest < Test::Unit::TestCase
-  context "A Options" do
-    def setup
-      @order = [:user, :recipients, :message, :sender, :test, :sign, :key]
-      @options = {:message=>"sos", :recipients=>"112"}
-      @options.extend(LittleSMS::Component::Options)
-      @options.method_path = {:method => :send, :component => :message }
-    end
-
-    should "load order from file" do
-      assert_equal(@order, @options.instance_eval("load_order(:message, :send)"))
-    end
-
-    should "sort with loaded order" do
-      assert_equal @options.sort, [[:recipients, "112"], [:message, "sos"]]
-    end
-
-    should "fail if unknown method called" do
-      @options.method_path = {:method => :unknown, :component => :message }
-      assert_raise LittleSMS::Component::Options::NoMethodError do
-         @options.sort
-      end
-    end
-
-    should "fail if unknown component accessed" do
-      @options.method_path = {:method => :unknown, :component => :unknown }
-      assert_raise LittleSMS::Component::Options::NoComponentError do
-         @options.sort
-      end
-    end
-  end
-end
-