bulutfon_sdk 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adca2477737bd616edcd6fabdd13fe91304cbbee
-  data.tar.gz: 04ff542450e9a1d88b8bc025ec2db220419ffcc0
+  metadata.gz: 46ed35e55bb3d1d1063cb1f02147df007c7ad8fa
+  data.tar.gz: 08466339da1fb22dcd8b1afd95b9091a3daf0a21
 SHA512:
-  metadata.gz: 839bd82673302bb7642115fa5698d3d434424f3140f0a36be3f038ca54043fd5c4c404c042b2abca7ea84b7b90d5ff8771f45ede30f649d0321e1e7514c20957
-  data.tar.gz: 7cfc36da333fda85788ef0d316862299f10e6bbce655fecd353c6ca16036e8c656391165bb1ce11343aa35c226f9f426e1057a815543729e05a511504ebc9192
+  metadata.gz: b2cfd79af389d4f9a20b633e2f7c67e69f94e51d6951be99fd246296da0723bcdb1f5c1fdccd55583f493292d32a29e84e29cdace9a91fae26a6c0e90e22ba0e
+  data.tar.gz: 3c534bacb65306dcf85a958fced31864a814dd7c8f95cd458a072a897a9e7a1606c349febc4e969a51c864ae5178a866c16f2223ed50783cdcd2054aba089787

data/README.md

@@ -1,5 +1,7 @@
 # Bulutfon Ruby SDK
 
+[![Gem Version](https://badge.fury.io/rb/bulutfon_sdk.svg)](https://badge.fury.io/rb/bulutfon_sdk)
+
 * [API Dokümantasyonu](https://github.com/bulutfon/documents/tree/master/API)
 * [Örnek Kodlar](https://github.com/bulutfon/ruby-sdk/tree/master/examples)
 
@@ -272,8 +274,63 @@ puts bulutfon.messages.create(params)
 methodlarını kullanabilirsiniz.
 
 Örnek kullanımları görmek için ve erişebileceğiniz değişkenler için [örnek kodlarımızı](https://github.com/bulutfon/ruby-sdk/tree/master/examples) inceleyebilirsiniz.
-    
+
+## Hash cevapları OpenStruct objesine dönüştürme
+
+### Hesap
+```ruby
+bulutfon = BulutfonSDK::REST::Bulutfon.new(token)
+# Hesap detaylarını hash olarak gösterir
+puts bulutfon.details
+# Örnek bir hesap detayları sonucu
+details = {
+    'user' =>{
+        'email' => 'test@bulutfon.com', 'name' => 'BULUTFON', 'gsm' => 'XXXXXXXXXXXX'
+    },
+    'pbx' =>{
+        'name' => 'test', 'url' => 'test.com', 'state' => 'CONFIRMED', 'package' => 'ENTERPRISE', 'customer_type' => 'CORPORATE'
+    },
+    'credit' =>{
+        'balance' => '10.00', 'sms_credit' => 0
+    }
+}
+# to_obj bizim hash sonuçları için tanımladığımız yardımcı metodumuz 
+detail_object = bulutfon.details.to_obj
+puts detail_object
+# Object örneği
+=begin
+#<OpenStruct
+  user=#<OpenStruct email="test@bulutfon.com", name="BULUTFON", gsm="XXXXXXXXXXXX">,
+  pbx=#<OpenStruct name="test", url="test.com", state="CONFIRMED", package="ENTERPRISE", customer_type="CORPORATE">,
+  credit=#<OpenStruct balance="10.00", sms_credit=0>>
+=end
+# Obje üzerinden alanlara şu şekilde ulaşabilirsiniz
+puts detail_object.user.email
+puts detail_object.user.name
+puts detail_object.pbx.name
+puts detail_object.pbx.url
+puts detail_object.credit.balance
+puts detail_object.credit.sms_credit
+```
+
+### Gruplar için örnek
+```ruby
+group_sdk   = BulutfonSDK::REST::Group.new(token)
+obj_result  = group_sdk.all.to_obj
+=begin
+#<OpenStruct
+  groups=[
+    #<OpenStruct id=1, number=11, name="Ofis - İstanbul", timeout=30>,
+    #<OpenStruct id=2, number=22, name="Ofis - Denizli", timeout=30>,
+    #<OpenStruct id=3, number=33, name="İngilizce", timeout=30>
+  ]>
+=end
+obj_result.groups.each do |group|
+  puts group.name
+end
+```
+
 ##Credits
 * ruby_sdk is maintained by [Lab2023](http://lab2023.com/) & [Bulutfon](https://www.bulutfon.com/)
 * Thank you to all the contributors!
-* The names and logos for Bulutfon are trademarks of Bulutfon
+* The names and logos for Bulutfon are trademarks of Bulutfon

data/examples/examples.rb

@@ -214,3 +214,63 @@ params = {
 }
 puts message.create(params)
 
+##############################################
+# Create OpenStruct object from hash
+##############################################
+
+# Account
+# -------------------------------------------------------------
+bulutfon = BulutfonSDK::REST::Bulutfon.new(token)
+# Get account details
+puts bulutfon.details
+
+# Details result is like below
+=begin
+details = {
+    'user' =>{
+        'email' => 'test@bulutfon.com', 'name' => 'BULUTFON', 'gsm' => 'XXXXXXXXXXXX'
+    },
+    'pbx' =>{
+        'name' => 'test', 'url' => 'test.com', 'state' => 'CONFIRMED', 'package' => 'ENTERPRISE', 'customer_type' => 'CORPORATE'
+    },
+    'credit' =>{
+        'balance' => '10.00', 'sms_credit' => 0
+    }
+}
+=end
+
+# to_obj is our helper method for hashes
+detail_object = bulutfon.details.to_obj
+puts detail_object
+
+# Object Example
+=begin
+#<OpenStruct
+  user=#<OpenStruct email="test@bulutfon.com", name="BULUTFON", gsm="XXXXXXXXXXXX">,
+  pbx=#<OpenStruct name="test", url="test.com", state="CONFIRMED", package="ENTERPRISE", customer_type="CORPORATE">,
+  credit=#<OpenStruct balance="10.00", sms_credit=0>>
+=end
+
+# You can access fields
+puts detail_object.user.email
+puts detail_object.user.name
+puts detail_object.pbx.name
+puts detail_object.pbx.url
+puts detail_object.credit.balance
+puts detail_object.credit.sms_credit
+
+# Groups
+# -------------------------------------------------------------
+group_sdk   = BulutfonSDK::REST::Group.new(token)
+obj_result  = group_sdk.all.to_obj
+=begin
+#<OpenStruct
+  groups=[
+    #<OpenStruct id=1, number=11, name="Ofis - İstanbul", timeout=30>,
+    #<OpenStruct id=2, number=22, name="Ofis - Denizli", timeout=30>,
+    #<OpenStruct id=3, number=33, name="İngilizce", timeout=30>
+  ]>
+=end
+obj_result.groups.each do |group|
+  puts group.name
+end

data/lib/bulutfon_sdk/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_obj
+    convert_to_obj self
+  end
+end

data/lib/bulutfon_sdk/helpers/data_helper.rb

@@ -0,0 +1,45 @@
+module BulutfonSDK
+  module Helpers
+    module DataHelper
+
+      ##
+      # Convert hash to object
+      def convert_to_obj(hash)
+        open_struct =  OpenStruct.new
+        set_open_struct_variables( open_struct, hash )
+        open_struct
+      end
+
+      ##
+      # Set hash variable to open_struct
+      # Recursive method for hash values
+      def set_open_struct_variables(open_struct, hash)
+        hash.each do |key,value|
+          if value.is_a? Hash
+            # create new open struct value
+            new_open_struct = OpenStruct.new
+            open_struct.send("#{key}=", new_open_struct)
+            set_open_struct_variables(new_open_struct, value)
+          elsif value.is_a? Array
+            open_struct.send("#{key}=", value)
+            value.each_with_index do |val, index|
+              if val.is_a? Hash
+                # create new open struct value
+                new_open_struct = OpenStruct.new
+                # set array index value variable
+                value[index] = new_open_struct
+                set_open_struct_variables(new_open_struct, val)
+              else
+                # Do nothing
+                # value[index] = val
+              end
+            end
+          else
+            open_struct.send("#{key}=", value)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/bulutfon_sdk/rest/base_request.rb

@@ -17,100 +17,103 @@ module BulutfonSDK
       end
 
       protected
+        ##
+        # Prepare URI object for file path
+        def prepare_uri(path, params = {})
+          uri       = uri_parse(params, path)
+          uri.query = URI.encode_www_form(params)
+          uri
+        end
 
-      ##
-      # Prepare URI object for file path
-      def prepare_uri(path, params = {})
-        request_path          = "#{@config.host}/#{path}"
-        uri                   = URI.parse(request_path)
-        params[:access_token] = @token
-        uri.query             = URI.encode_www_form(params)
-        uri
-      end
-
-      ##
-      # Prepare http request
-      def prepare_request(method, path, params = {})
-        request_path          = "#{@config.host}/#{path}"
-        uri                   = URI.parse(request_path)
-        params[:access_token] = @token
-        uri.query             = URI.encode_www_form(params) if ['get', 'delete'].include?(method)
-        method_class          = Net::HTTP.const_get method.to_s.capitalize
-        request               = method_class.new(uri.to_s, HTTP_HEADERS)
-        request.form_data     = params if ['post', 'put'].include?(method)
-        connect_and_send(request)
-      end
-
-      ##
-      # Prepare http request for file saving
-      def save_file(method, path, save_path)
-        uri          = prepare_uri(path)
-        method_class = Net::HTTP.const_get method.to_s.capitalize
-        request      = method_class.new(uri.to_s, HTTP_HEADERS)
-        response     = connect_and_send(request, is_file: true )
-        begin
-          file = File.open(save_path, 'w')
-          file.write(response)
-        rescue => error
-          raise BulutfonSDK::REST::SDKError.new error
-        ensure
-          file.close unless file.nil?
+        ##
+        # Prepare http request
+        def prepare_request(method, path, params = {})
+          uri                   = uri_parse(params, path)
+          uri.query             = URI.encode_www_form(params) if ['get', 'delete'].include?(method)
+          method_class          = Net::HTTP.const_get method.to_s.capitalize
+          request               = method_class.new(uri.to_s, HTTP_HEADERS)
+          request.form_data     = params if ['post', 'put'].include?(method)
+          connect_and_send(request)
         end
-        { file: file, save_path: save_path }
-      end
 
-      ##
-      # Set up and cache a Net::HTTP object to use when making requests.
-      def set_up_connection # :doc:
-        uri                = URI.parse(@config.host)
-        @http              = Net::HTTP.new(uri.host, uri.port, p_user = @config.proxy_user, p_pass =  @config.proxy_pass)
-        @http.use_ssl      = true
-        @http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
-        @http.use_ssl      = @config.use_ssl
-        if @config.ssl_verify_peer
-          @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          @http.ca_file     = @config.ssl_ca_file
-        else
-          @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        ##
+        # URI parse for params
+        def uri_parse(params, path)
+          request_path = "#{@config.host}/#{path}"
+          uri = URI.parse(request_path)
+          params[:access_token] = @token
+          uri
         end
-        @http.open_timeout = @config.timeout
-        @http.read_timeout = @config.timeout
-      end
 
-      ##
-      # Send an HTTP request using the cached <tt>@http</tt> object and
-      # return the JSON response body parsed into a hash. Also save the raw
-      # Net::HTTP::Request and Net::HTTP::Response objects as
-      # <tt>@last_request</tt> and <tt>@last_response</tt> to allow for
-      # inspection later.
-      def connect_and_send(request, is_file = false ) # :doc:
-        @last_request = request
-        retries_left = @config.retry_limit
-        begin
-          response = @http.request request
-          @last_response = response
-          if response.kind_of? Net::HTTPServerError
-            raise BulutfonSDK::REST::ServerError
+        ##
+        # Prepare http request for file saving
+        def save_file(method, path, save_path)
+          uri          = prepare_uri(path)
+          method_class = Net::HTTP.const_get method.to_s.capitalize
+          request      = method_class.new(uri.to_s, HTTP_HEADERS)
+          response     = connect_and_send(request, is_file: true )
+          begin
+            file = File.open(save_path, 'w')
+            file.write(response)
+          rescue => error
+            raise BulutfonSDK::REST::SDKError.new error
+          ensure
+            file.close unless file.nil?
           end
-        rescue
-          raise if request.class == Net::HTTP::Post
-          if retries_left > 0 then retries_left -= 1; retry else raise end
+          { file: file, save_path: save_path }
         end
-        if response.body and !response.body.empty?
-          if is_file
-            object = response.body
+
+        ##
+        # Set up and cache a Net::HTTP object to use when making requests.
+        def set_up_connection # :doc:
+          uri                = URI.parse(@config.host)
+          @http              = Net::HTTP.new(uri.host, uri.port, p_user = @config.proxy_user, p_pass =  @config.proxy_pass)
+          @http.verify_mode  = OpenSSL::SSL::VERIFY_NONE
+          @http.use_ssl      = @config.use_ssl
+          if @config.ssl_verify_peer
+            @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            @http.ca_file     = @config.ssl_ca_file
           else
-            object = MultiJson.load response.body
+            @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
           end
-        elsif response.kind_of? Net::HTTPBadRequest
-          object = { message: 'Bad request', code: 400 }
+          @http.open_timeout = @config.timeout
+          @http.read_timeout = @config.timeout
         end
 
-        if response.kind_of? Net::HTTPClientError
-          raise BulutfonSDK::REST::RequestError.new object['error'], object['code']
+        ##
+        # Send an HTTP request using the cached <tt>@http</tt> object and
+        # return the JSON response body parsed into a hash. Also save the raw
+        # Net::HTTP::Request and Net::HTTP::Response objects as
+        # <tt>@last_request</tt> and <tt>@last_response</tt> to allow for
+        # inspection later.
+        def connect_and_send(request, is_file = false ) # :doc:
+          @last_request = request
+          retries_left = @config.retry_limit
+          begin
+            response = @http.request request
+            @last_response = response
+            if response.kind_of? Net::HTTPServerError
+              raise BulutfonSDK::REST::ServerError
+            end
+          rescue
+            raise if request.class == Net::HTTP::Post
+            if retries_left > 0 then retries_left -= 1; retry else raise end
+          end
+          if response.body and !response.body.empty?
+            if is_file
+              object = response.body
+            else
+              object = MultiJson.load response.body
+            end
+          elsif response.kind_of? Net::HTTPBadRequest
+            object = { message: 'Bad request', code: 400 }
+          end
+
+          if response.kind_of? Net::HTTPClientError
+            raise BulutfonSDK::REST::RequestError.new object['error'], object['code']
+          end
+          object
         end
-        object
-      end
 
     end
   end

data/lib/bulutfon_sdk/version.rb

@@ -1,3 +1,3 @@
 module BulutfonSDK
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

data/lib/bulutfon_sdk.rb

@@ -6,9 +6,12 @@ require 'openssl'
 require 'open3'
 require 'mime/types'
 require 'base64'
+require 'ostruct'
 
 require 'bulutfon_sdk/version' unless defined?(BulutfonSDK::VERSION)
 require 'bulutfon_sdk/util'
+require 'bulutfon_sdk/helpers/data_helper'
+require 'bulutfon_sdk/hash'
 require 'bulutfon_sdk/rest/bulutfon'
 require 'bulutfon_sdk/rest/message'
 require 'bulutfon_sdk/rest/did'
@@ -24,6 +27,8 @@ require 'bulutfon_sdk/rest/message_title'
 require 'bulutfon_sdk/util/client_config'
 require 'bulutfon_sdk/rest/errors'
 
+include BulutfonSDK::Helpers::DataHelper
+
 module BulutfonSDK
   # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulutfon_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Ismail Akbudak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-21 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -106,6 +106,8 @@ files:
 - examples/pdf-sample.pdf
 - examples/test.wav
 - lib/bulutfon_sdk.rb
+- lib/bulutfon_sdk/hash.rb
+- lib/bulutfon_sdk/helpers/data_helper.rb
 - lib/bulutfon_sdk/rest/announcement.rb
 - lib/bulutfon_sdk/rest/automatic_call.rb
 - lib/bulutfon_sdk/rest/base_request.rb
@@ -143,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Bulutfon Ruby SDK.