ileti_merkezi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d8ca4c9c2baa6448dae75a695a6dcb83bdb3021
+  data.tar.gz: ead6b427e956c5a9d7ebd9a5eb58b7f8e91dfdf9
+SHA512:
+  metadata.gz: 96ce7a9542d776e8b720e1e12ce87aff6229257c76287c48d28e8d05accb66ef37c058915c8e72edc6229948bef6a15765c436299514e25117c37fa5d26460b3
+  data.tar.gz: '009658482f1f196506f82e82895e45e58b5b6baf95ac344b00475947ee4fe6aff690c3ac404c3af305647db74102701a63d19997dbd92eab9fde8393ca0a05cc'

data/.circleci/config.yml

@@ -0,0 +1,33 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/ims
+    docker:
+      - image: circleci/ruby:2.4-node
+        environment:
+          RACK_ENV: test
+
+    steps:
+      - checkout
+      
+      - restore_cache:
+          keys:
+            - iletimerkezi-bundle-{{ checksum "Gemfile.lock" }}
+            - iletimerkezi-bundle-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: iletimerkezi-bundle-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Rubocop Check
+          command: bundle exec rubocop
+
+      - run:
+          name: Test
+          command: bundle exec rake test

data/.env

@@ -0,0 +1,4 @@
+IM_USERNAME='username'
+IM_PASSWORD='password'
+IM_SENDER='ILETI MRKZI'
+TEST_PHONE='06664443322'

data/.envrc

@@ -0,0 +1,2 @@
+export PATH="$PWD"/bin:"$PATH"
+export RUBYLIB="$PWD"/lib

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.reek

@@ -0,0 +1,17 @@
+exclude_paths:
+  - test
+
+UtilityFunction:
+  public_methods_only: true
+
+IrresponsibleModule:
+  enabled: false
+
+ManualDispatch:
+  exclude:
+  - 'IletiMerkezi::Request#http'
+
+FeatureEnvy:
+  exclude:
+    - 'Account#info'
+    - 'Account#senders'

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Exclude:
+    - 'iletimerkezisms.gemspec'
+    - 'test/**/**'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/iletimerkezisms.rb'
+
+Metrics/LineLength:
+  Max: 85

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at irfan.subas@uzem.omu.edu.tr. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem 'dotenv'
+  gem 'pry'
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'minitest-focus'
+  gem 'minitest-reporters'
+  gem 'vcr'
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    ileti_merkezi (0.1.0)
+      ox (~> 2.8, >= 2.8.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ansi (1.5.0)
+    ast (2.3.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    dotenv (2.2.1)
+    hashdiff (0.3.7)
+    method_source (0.9.0)
+    minitest (5.11.1)
+    minitest-focus (1.1.2)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.1.19)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    ox (2.8.2)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    unicode-display_width (1.3.0)
+    vcr (4.0.0)
+    webmock (3.2.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dotenv
+  ileti_merkezi!
+  minitest (~> 5.0)
+  minitest-focus
+  minitest-reporters
+  pry
+  rake (~> 10.0)
+  rubocop
+  vcr
+  webmock
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 İrfan Subaş
+
+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,287 @@
+[![CircleCI](https://circleci.com/gh/isubas/ileti_merkezi.svg?style=svg)](https://circleci.com/gh/isubas/ileti_merkezi)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b427c95759e1dca1e3dc/maintainability)](https://codeclimate.com/github/isubas/ileti_merkezi/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/b427c95759e1dca1e3dc/test_coverage)](https://codeclimate.com/github/isubas/ileti_merkezi/test_coverage)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cecce51ce4d94f3ca1dcc1e99bdcbce6)](https://www.codacy.com/app/isubas/ileti_merkezi?utm_source=github.com&utm_medium=referral&utm_content=isubas/ileti_merkezi&utm_campaign=Badge_Grade)
+
+# IletiMerkezi
+iletimerkezi.com API'lerini kullanarak toplu sms gönderme ve raporlama
+işlemlerini yapabilmek için hazırlanan Ruby istemcisidir.
+
+## Kurulum
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ileti_merkezi'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ileti_merkezi
+
+## Kullanım
+
+### Yapılandırma
+
+Rails uygulamanızda `config/initializers/ileti_merkezi_configure.rb` dosyası oluştururak 
+aşağıdaki kodları içerisine yapıştırınız.
+
+Eğer kimlik doğrulama işlemini kullanıcı adı ve parola üzerinden yapmak istiyorsanız username ve passord bilgilerini,
+token tabalı yapmak istiyorsanız public_key ve secret_key bilgilerini doldurmanız gerekmektedir.
+
+Bu dört alanda doldurulmuş ise sistem token tabanlı doğrulama yapacaktır.
+
+public ve secret key bilgilerini https://www.iletimerkezi.com/user/preferences adresinden oluşturabilirsiniz.
+
+```ruby
+IletiMerkezi.configure do |config|
+  # Default: http://api.iletimerkezi.com/v1'
+  config.endpoint          = 'http://api.iletimerkezi.com/v1'
+  config.sender            = 'FOO'
+  # opsiyonel
+  config.request_overrides = {
+    use_ssl: true # default false
+    verify_mode: OpenSSL::SSL::VERIFY_PEER,
+    read_timeout: 30, # default 30
+    open_timeout: 30 # default 30
+  } 
+  # Kimlik Doğrulama: username ve password
+  config.username = 'username'
+  config.password = 'password'
+  # Kimlik Doğrulama: token tabanlı
+  config.public_key = 'public_key'
+  config.secret_key = 'secret_key'
+end
+```
+
+Veya 
+
+- Ortam değişkeleri ile yapılandırabilirsiniz. bknz: .env
+
+```ruby
+IM_ENDPOINT = 'http://api.iletimerkezi.com/v1' # Default: http://api.iletimerkezi.com/v1
+# Kimlik Doğrulama: username ve password
+IM_USERNAME = 'username'
+IM_PASSWORD = 'password'
+# Kimlik Doğrulama: token tabanlı
+IM_PUBLIC_KEY = 'public_key'
+IM_SECRET_KEY = 'secret_key'
+
+IM_SENDER = 'SENDER'
+```
+
+### SMS Gönderme
+
+#### Tek Mesaj - Çoklu Alıcı
+
+```ruby
+
+  args = {
+    send_datetime: '15/01/2017 12:00' # Opsiyonel 
+    sender: 'TEST' # Opsiyonel
+    phones: ['0555 555 00 01', '0555 555 00 02']
+    text: 'Test Mesajı'
+  }
+
+  # return IletiMerkezi::Response
+  response = IletiMerkezi.send(args)
+  # veya  
+  sms      = IletiMerkezi::Sms.new(args)
+  response = sms.send
+
+  response.code # return 200
+  response.body # http raw body
+  response.message # return status message
+  response.error? # return true or false
+  response.to_h
+  # return hash
+  { 
+    :status => {
+      :code => "200",
+      :message => "İşlem başarılı"
+    },
+    :order => {
+      :id => "order_id"
+    }
+  }
+```
+
+#### Çoklu Mesaj - Çoklu Alıcı 
+
+```ruby
+  args = {
+    send_datetime: '15/01/2017 12:00' # Opsiyonel 
+    sender: 'TEST' # Opsiyonel
+    messages: [
+      {
+        text: 'Test Mesajı Bir',
+        phones: ['0555 555 00 01', '0555 555 00 02'],
+      },
+      {
+        text: 'Test Mesajı İki',
+        phones: ['0555 555 00 03', '0555 555 00 04'],
+      }
+    ]
+  }
+
+  # return IletiMerkezi::Response
+  response = IletiMerkezi.send(args)
+  # veya
+  sms      = IletiMerkezi::Sms.new(args)
+  response = sms.send
+
+  response.code # return 200
+  response.body # http raw body
+  response.message # return status message
+  response.error? # return true or false
+  response.to_h
+  # return hash
+  { 
+    :status => {
+      :code => "200",
+      :message => "İşlem başarılı"
+    },
+    :order => {
+      :id => "order_id"
+    }
+  }
+```
+
+### Zamanlamış SMS Gönderim İptali
+
+- **Not**: Yalnız gelecek ki bir zamanda gönderilecek sms siparişleri iptal edilebilir.
+
+```ruby
+  # return IletiMerkezi::Response
+  response = IletiMerkezi.cancel(order_id)
+  # or
+  cancel   = IletiMerkezi::Cancel.new(order_id)
+  response = cancel.confirm
+
+  response.code # return 200
+  response.body # http raw body
+  response.message # return status message
+  response.error? # return true or false
+  response.to_h 
+  # return hash
+  {
+    :status => {
+      :code => "200",
+      :message => "İşlem başarılı"
+    }
+  }
+
+```
+
+#### Bakiye Sorgulama
+
+```ruby
+  # return IletiMerkezi::Response
+  response = IletiMerkezi.balance
+
+  response.code # return 200
+  response.body # http raw body
+  response.message # return status message
+  response.error? # return true or false
+  response.to_h
+  # return
+  { 
+    :status => {
+      :code => "200",
+      :message => "İşlem başarılı"
+    },
+    :balance => { 
+      :amount => "1",
+      :sms => "238760"
+    }
+  }
+```
+
+### SMS Sipariş Raporlama
+
+#### Ek Bilgi:
+  
+  - **page**: zorunlu değildir. Bir siparişteki alıcı sayısı row_count(1000)'den fazla 
+             ise page parametresi kullanılarak diğer rapor sayfaları için istek yapılabilir.
+  - **row_count**: Bir sayfada göntülenecek rapor sayısı
+
+```ruby
+  # return IletiMerkezi::Response
+  response = IletiMerkezi.report(order_id, page: 1, row_count: 1000) # defaults: (page: 1, row_count: 1000)
+  # veya
+  report   = IletiMerkezi::Report.new(order_id, page: 1, row_count: 1000)
+  response = report.query
+
+  response.code # return 200
+  response.body # http raw body
+  response.message # return status message
+  response.error? # return true or false
+  response.to_h
+  # return hash
+  {
+    :status => {
+      :code => "200",
+      :message =>"İşlem başarılı"
+    },
+    :order => {
+      :id => "order_id",
+      :status => "114",
+      :total => "1",
+      :delivered => "1",
+      :undelivered => nil,
+      :waiting => nil,
+      :submitAt => "2018-01-16 15:08:37",
+      :sendAt => "2018-01-16 15:08:00",
+      :sender => "OMU UZEM",
+      :price => "1",
+      :status => "114",
+      :message => [
+        { :number=>"+9055XXXXXXXX", :status=>"111" },
+        { :number=>"+9055XXXXXXXX", :status=>"111" }
+      ]
+    }
+  }
+```
+
+### Servis Durumu
+
+```ruby
+  IletiMerkezi.status # return true or false
+```
+
+### Hesap Bilgileri
+
+**Not:** Kullanıcı adı ve paralo bilgilerinin yapılandırmada doldurulmuş olması gerekmektedir.  
+
+```ruby
+  IletiMerkezi.info
+```
+
+### Hesabınıza Tanımlı Başlık Bilgileri
+
+**Not:** Kullanıcı adı ve paralo bilgilerinin yapılandırmada doldurulmuş olması gerekmektedir. 
+
+```
+  IletiMerkezi.senders
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/isubas/ileti_merkezi. 
+This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the 
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IletiMerkezi project’s codebases, issue trackers, 
+chat rooms and mailing lists is expected to follow the 
+[code of conduct](https://github.com/isubas/ileti_merkezi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ileti_merkezi'
+require 'dotenv/load'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ileti_merkezi.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ileti_merkezi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ileti_merkezi'
+  spec.version       = IletiMerkezi::VERSION
+  spec.authors       = ['İrfan SUBAŞ']
+  spec.email         = ['irfan.isubas@gmail.com']
+
+  spec.summary       = 'api.iletimerkezi.com API Ruby SMS GEM"'
+  spec.description   = '
+    api.iletimerkezi.com uzerinden toplu sms gonderme,
+    raporlama gibi islemleri yapabilmek icin hazırlanmistir.
+  '
+  spec.homepage      = 'https://github.com/isubas/ileti_merkezi'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'ox', '~> 2.8', '>= 2.8.2'
+end

data/lib/ileti_merkezi/account.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module IletiMerkezi
+  # Account
+  class Account
+    PATH =
+      'http://dev.iletimerkezi.com/index.php?function=api&'\
+      '&special_username=Ns_eemsm&special_password=_Arg_ns_mmm'.freeze
+
+    class << self
+      def info
+        request     = Request.new(body: body_for_info)
+        request.uri = URI.parse(PATH + '&obj1=getUserInfo')
+        request.call
+      end
+
+      def senders
+        request     = Request.new(body: body_for_senders)
+        request.uri = URI.parse(PATH + '&obj1=getSmsHeader')
+        request.call
+      end
+
+      private
+
+      def body_for_senders
+        config = IletiMerkezi.configuration
+        <<-XML.gsub(/^[ ]+/, '').strip
+        <smsApi>
+          <userInfo>
+            <userName>#{config.username}</userName>
+            <userPassword>#{config.password}</userPassword>
+            <smsType>2</smsType>
+          </userInfo>
+        </smsApi>
+        XML
+      end
+
+      def body_for_info
+        config = IletiMerkezi.configuration
+        <<-XML.gsub(/^[ ]+/, '').strip
+        <userInfo>
+          <userName>#{config.username}</userName>
+          <userPassword>#{config.password}</userPassword>
+        </userInfo>
+        XML
+      end
+    end
+  end
+end