pechkinrb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd3a89fe6b95d51923b3f65d041b7afe41218bf2
+  data.tar.gz: 1eb794dec52e6516e6c40333114bbf28bf6d096b
+SHA512:
+  metadata.gz: c7f8ad2a4c1c40c6853eab8b4fe590421ba7e1d5b5a8471fdda97fd0c47d588e47523e5ac5781c3e82349f0bea18840b34d297698c5941eb59605c1e900eeb66
+  data.tar.gz: efd2cab51e9ef1c39972fff1baddc33e807d969097fc883a3b0f8bcd93a2525aaac3b049c22b57921d37b03455fef739ec50b7632af982f10d3ecc712f7b0eb9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alexandr Prokopenko
+
+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,32 @@
+# Pechkinrb
+
+This gem provides you with easy Ruby interface for pechkin-mail.ru mail service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pechkinrb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pechkinrb
+
+## Usage
+
+    require "pechkinrb"
+    conn = Pechkin::Connection.new('login', 'password')
+    conn.lists # => Array of Pechkin::List instances
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pechkinrb/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/lib/pechkinrb/api_exception.rb

@@ -0,0 +1,4 @@
+module Pechkin
+  class ApiException < StandardError      
+  end
+end

data/lib/pechkinrb/list.rb

@@ -0,0 +1,50 @@
+module Pechkin
+  # Mailing list representation class
+  class List < Model
+    attr_reader :raw
+
+    FIELDS = [
+      :id,
+      :state,
+      :count_active,
+      :count_all,
+      :name,
+      :description,
+      :company,
+      :abuse_name,
+      :phone,
+      :address,
+      :city,
+      :url
+    ]
+
+    FIELDS.each do |f|
+      attr_reader f
+    end
+
+    # Initialize new list instance
+    #
+    # @param connection [Pachkin::Connection] Active connection
+    # @param doc [Hash] API object data
+    def initialize(connection, doc)
+      super(connection, doc)
+      FIELDS.each do |field|
+        instance_variable_set :"@#{field}", doc[field.to_s]
+      end
+    end
+
+    # Invokes 'lists.get_members' API method to retreive list members
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Array] Array of Pechkin::Members instances
+    def get_members(params = {})
+      connection.call_method('lists.get_members', params.merge(id_params)).map {|member| Pechkin::Member.new(connection, member)}
+    end
+
+    private
+
+    def id_params
+      {list_id: id}
+    end
+  end
+end

data/lib/pechkinrb/member.rb

@@ -0,0 +1,62 @@
+module Pechkin
+  class Member < Model
+    attr_reader :raw
+
+    FIELDS = [
+      :id,
+      :list_id,
+      :email,
+      :state,
+      :merge_1,
+      :merge_2,
+      :merge_3,
+      :merge_4,
+      :merge_5,
+      :optin_time,
+      :unsub_time,
+      :lastedit_time
+    ]
+
+    FIELDS.each do |f|
+      attr_reader f
+    end
+
+    # Initialize new member instance
+    #
+    # @param connection [Pachkin::Connection] Active connection
+    # @param doc [Hash] API object data
+    def initialize(connection, doc)
+      super(connection, doc)
+      FIELDS.each do |field|
+        instance_variable_set :"@#{field}", doc[field.to_s]
+      end
+    end
+
+    # Invokes 'lists.delete_member' API method
+    #
+    def delete_member
+      connection.call_method('lists.delete_member', id_params)
+    end
+
+    # Invokes 'lists.update_member' API method
+    #
+    # @param params [Hash] Params to be passed
+    def update_member(params)
+      connection.call_method('lists.update_member', params.merge(id_params))
+    end
+
+    # Invokes 'lists.get_lists' API method to retrieve member list
+    #
+    # @return params [Pechkin::List] List instance, accosiated with member
+    def list
+      connection.get_list(list_id)
+    end
+
+    private
+
+    def id_params
+      {member_id: id}
+    end
+
+  end
+end

data/lib/pechkinrb/model.rb

@@ -0,0 +1,24 @@
+module Pechkin
+  # Basic class for API model objects
+  class Model
+
+    # API object data
+    attr_reader :raw
+
+    # Initialize new model instance
+    #
+    # @param connection [Pachkin::Connection] Active connection
+    # @param doc [Hash] API object data
+    def initialize(connection, doc)
+      @connection = connection
+      @raw = doc
+    end
+
+    protected
+
+    def connection
+      @connection
+    end
+
+  end
+end

data/lib/pechkinrb/pechkin.rb

@@ -0,0 +1,71 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Pechkin
+  class Connection
+
+    API_URL = 'https://api.pechkin-mail.ru'
+
+    # Initializes new connection instance
+    #
+    # @param username [String] Service username
+    # @param password [String] Password
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+
+    # Memoized Faraday connection factory
+    #
+    # @return Faraday connection instance
+    def connection
+      @conn ||= Faraday.new(:url => 'https://api.pechkin-mail.ru') do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :json
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    # Invokes API method by name
+    #
+    # @param method [String] Method name, corresponding API reference https://pechkin-mail.ru/api/
+    # @param params [Hash] Params to be passed
+    def call_method(method, params = {})
+      response = connection.post '/', {method: method}.merge(credentials).merge(params)      
+      err_code = response.body["response"]["msg"]["err_code"]
+      unless err_code == 0
+        raise Pechkin::ApiException.new(response.body["response"]["msg"]["text"])
+      end
+      response.body["response"]["data"]
+    end
+
+    # Invokes 'lists.get' API method
+    #
+    # @param params [Hash] Params to be passed
+    # @return [Array] Array of Pechkin::List instances
+    def lists(params = {})
+      call_method('lists.get', params).map {|list_raw| Pechkin::List.new(self, list_raw)}
+    end
+
+    # Invokes 'lists.get' API method to retrieve single List object
+    #
+    # @param id [Fixnum] List id
+    # @return [Pechkin::List] List instance
+    def get_list(id)
+      lists(list_id: id)[0]
+    end
+
+    # Invokes 'lists.get_member' API method
+    #
+    # @param email [String] Email for search
+    # @return [Array] Array of Pechkin::Member instances
+    def get_member(email)
+      call_method('lists.get_member', {email: email}).map {|member| Pechkin::Member.new(connection, member)}
+    end
+
+  private
+
+    def credentials
+      {username: @username, password: @password}
+    end
+  end
+end

data/lib/pechkinrb/version.rb

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

data/lib/pechkinrb.rb

@@ -0,0 +1,7 @@
+require "pechkinrb/version"
+
+require "pechkinrb/api_exception"
+require "pechkinrb/model"
+require "pechkinrb/member"
+require "pechkinrb/list"
+require "pechkinrb/pechkin"

data/pechkinrb.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pechkinrb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pechkinrb"
+  spec.version       = Pechkinrb::VERSION
+  spec.authors       = ["Alexandr Prokopenko"]
+  spec.email         = ["prokopenko@igc.ru"]
+  spec.summary       = %q{Interface for pechkin-mail.ru service API}
+  spec.description   = %q{Interface for pechkin-mail.ru service API}
+  spec.homepage      = "https://github.com/crsde/PechkinRb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+end

data/spec/connection_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Pechkin::Connection do
+  let(:connection) { Pechkin::Connection.new('1', '2') }
+
+  before(:each) do
+    stub_connection = Faraday.new do |builder|
+      # builder.response :logger
+      builder.response :json
+
+      builder.adapter :test do |stubs|
+        stubs.post("/", {username: '1', password: '2', method: 'get_good', param: 'value'} ) do
+          [200, {}, {
+            'response' =>
+              {
+                'msg' => { 'text' => "OK", 'err_code' => 0 },
+                'data' => { 'ok' => "ok" }
+              }
+          }]
+        end
+
+        stubs.post("/", {username: '1', password: '2', method: 'get_bad', param: 'value'} ) do
+          [200, {}, {
+            'response' =>
+              {
+                'msg' => { 'text' => "Error", 'err_code' => 1 },
+                'data' => { 'ok' => "ok" }
+              }
+          }]
+        end
+      end
+    end
+
+    expect(connection).to receive(:connection).and_return(stub_connection)
+  end
+
+  describe "#call_method" do
+    it "returns response data" do
+      expect(connection.call_method('get_good', {param: 'value'})).to eq('ok' => "ok")
+    end
+
+    it "raises error when bad response received" do
+      expect { connection.call_method('get_bad', {param: 'value'}) }.to raise_error(Pechkin::ApiException)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'pechkinrb'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: pechkinrb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexandr Prokopenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interface for pechkin-mail.ru service API
+email:
+- prokopenko@igc.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pechkinrb.rb
+- lib/pechkinrb/api_exception.rb
+- lib/pechkinrb/list.rb
+- lib/pechkinrb/member.rb
+- lib/pechkinrb/model.rb
+- lib/pechkinrb/pechkin.rb
+- lib/pechkinrb/version.rb
+- pechkinrb.gemspec
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/crsde/PechkinRb
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Interface for pechkin-mail.ru service API
+test_files:
+- spec/connection_spec.rb
+- spec/spec_helper.rb
+has_rdoc: