| 1 | package VR::API; | ||
| 2 | use strict; | ||
| 3 | |||
| 4 | use SOAP::Lite; | ||
| 5 | |||
| 6 | our $VERSION = '1.06'; | ||
| 7 | |||
| 8 | sub _uri { | ||
| 9 | 'VR/API/1_0' | ||
| 10 | } | ||
| 11 | |||
| 12 | sub _methods { | ||
| 13 | qw( | ||
| 14 | addListMember | ||
| 15 | appendFileToList | ||
| 16 | appendFileToListBackground | ||
| 17 | appendTemplateCampaignModule | ||
| 18 | calculateCampaignAudience | ||
| 19 | canCallMethod | ||
| 20 | checkFreeformContent | ||
| 21 | compileCampaignRecipientResults | ||
| 22 | compileCampaignRecipientResultsBackground | ||
| 23 | createEmailCampaign | ||
| 24 | createList | ||
| 25 | createOptinForm | ||
| 26 | deleteCampaign | ||
| 27 | deleteList | ||
| 28 | deleteListMember | ||
| 29 | deleteTemplateCampaignModule | ||
| 30 | downloadCampaignRecipientResults | ||
| 31 | downloadCampaignRecipientResultsBackground | ||
| 32 | downloadCompanyUnsubscribesAndBounces | ||
| 33 | downloadList | ||
| 34 | downloadListBackground | ||
| 35 | editCompany | ||
| 36 | editListAttribute | ||
| 37 | editListMember | ||
| 38 | editUser | ||
| 39 | enumerateEmailCampaigns | ||
| 40 | enumerateLists | ||
| 41 | enumeratePostcardCampaigns | ||
| 42 | eraseListMembers | ||
| 43 | getCampaignDomainCount | ||
| 44 | getCompany | ||
| 45 | getEmailCampaignDeclineHistory | ||
| 46 | getEmailCampaignResponseHistograms | ||
| 47 | getEmailCampaignStats | ||
| 48 | getEmailCreditBalance | ||
| 49 | getListDomainCount | ||
| 50 | getListMemberByAddressHash | ||
| 51 | getListMemberByEmailAddress | ||
| 52 | getListMemberByEmailAddress | ||
| 53 | getListMemberByHash | ||
| 54 | getListMembers | ||
| 55 | getUser | ||
| 56 | getUserByEmailAddress | ||
| 57 | launchEmailCampaign | ||
| 58 | login | ||
| 59 | refresh | ||
| 60 | renderCampaignContent | ||
| 61 | searchListMembers | ||
| 62 | sendEmailCampaignTest | ||
| 63 | setCampaignLists | ||
| 64 | setCustomListFields | ||
| 65 | setDisplayedListFields | ||
| 66 | setEmailCampaignAttribute | ||
| 67 | setEmailCampaignContent | ||
| 68 | setIndexedListFields | ||
| 69 | setTemplateCampaignModule | ||
| 70 | transferEmailCredits | ||
| 71 | undeleteCampaign | ||
| 72 | undeleteList | ||
| 73 | unlaunchEmailCampaign | ||
| 74 | validateStreetAddress | ||
| 75 | ); | ||
| 76 | } | ||
| 77 | |||
| 78 | sub _on_fault { | ||
| 79 | my($soap, $res) = @_; | ||
| 80 | if( ref( $res ) ) { | ||
| 81 | my $error_string = ""; | ||
| 82 | if( $soap->endpoint ) { | ||
| 83 | $error_string .= "Error while communicating with " . $soap->endpoint . " - "; | ||
| 84 | } | ||
| 85 | if( $res->faultcode ) { | ||
| 86 | $error_string .= "SOAP Fault Code: " . $res->faultcode . ": "; | ||
| 87 | } | ||
| 88 | if( $res->faultstring ) { | ||
| 89 | $error_string .= "SOAP Fault String: " . $res->faultstring . " - "; | ||
| 90 | } | ||
| 91 | die $error_string; | ||
| 92 | } else { | ||
| 93 | die $soap->transport->status; | ||
| 94 | } | ||
| 95 | } | ||
| 96 | |||
| 97 | sub _on_debug { | ||
| 98 | foreach( @_ ) { | ||
| 99 | print $_, "\n"; | ||
| 100 | } | ||
| 101 | } | ||
| 102 | |||
| 103 | sub _getAction { | ||
| 104 | my $self = shift; | ||
| 105 | my $method = shift; | ||
| 106 | $self->_uri . "#" . $method; | ||
| 107 | } | ||
| 108 | |||
| 109 | sub _getArgsType { | ||
| 110 | my $self = shift; | ||
| 111 | my $method = shift; | ||
| 112 | if( $method =~ /^(.+)Background$/ ) { | ||
| 113 | return 'vrtypens:' . $1 . 'Args'; | ||
| 114 | } else { | ||
| 115 | return 'vrtypens:' . $method . "Args"; | ||
| 116 | } | ||
| 117 | } | ||
| 118 | |||
| 119 | sub _call { | ||
| 120 | my $self = shift; | ||
| 121 | my $method = shift; | ||
| 122 | my $args = shift; | ||
| 123 | |||
| 124 | my $qualified_args = SOAP::Data->name( 'args' ) | ||
| 125 | ->value( $args ) | ||
| 126 | ->type( $self->_getArgsType( $method ) ) | ||
| 127 | ->attr( {'xmlns:vrtypens' => 'http://api.verticalresponse.com/1.0/VRAPI' } ); | ||
| 128 | |||
| 129 | my $som = $self->client | ||
| 130 | ->proxy( $self->endpoint ) | ||
| 131 | ->endpoint( $self->endpoint ) | ||
| 132 | ->uri( $self->_uri ) | ||
| 133 | ->on_action( sub { __PACKAGE__->_getAction( $method ) } ) | ||
| 134 | ->call( $method => $qualified_args ); | ||
| 135 | |||
| 136 | if( $som && ref( $som ) && $som->isa( 'SOAP::SOM') ) { | ||
| 137 | # Remember the session_id from login() calls | ||
| 138 | $self->session_id( $som->result ) if( 'login' eq $method ); | ||
| 139 | return wantarray ? $som->paramsall : $som->result; | ||
| 140 | } else { | ||
| 141 | return $som; | ||
| 142 | } | ||
| 143 | } | ||
| 144 | |||
| 145 | sub new { | ||
| 146 | my $self = shift; | ||
| 147 | my $client = SOAP::Lite->new->on_fault( \&VR::API::_on_fault ); | ||
| 148 | # For debugging, uncomment the line below | ||
| 149 | # $client->on_debug( \&VR::API::_on_debug ); | ||
| 150 | my $object = bless { | ||
| 151 | _client => $client, | ||
| 152 | _endpoint => ($ENV{VR_API_SOAP_ENDPOINT} || 'https://api.verticalresponse.com/1.0/VRAPI'), | ||
| 153 | _session_id => undef, | ||
| 154 | }, $self; | ||
| 155 | return $object; | ||
| 156 | } | ||
| 157 | |||
| 158 | sub logout { | ||
| 159 | my $self = shift; | ||
| 160 | delete $self->{_session_id}; | ||
| 161 | } | ||
| 162 | |||
| 163 | sub client { | ||
| 164 | my $self = shift; | ||
| 165 | if( @_ ) { | ||
| 166 | my $old = $self->{_client}; | ||
| 167 | $self->{_client} = shift @_; | ||
| 168 | return $old; | ||
| 169 | } else { | ||
| 170 | return $self->{_client}; | ||
| 171 | } | ||
| 172 | } | ||
| 173 | |||
| 174 | sub endpoint { | ||
| 175 | my $self = shift; | ||
| 176 | if( @_ ) { | ||
| 177 | my $old = $self->{_endpoint}; | ||
| 178 | $self->{_endpoint} = shift @_; | ||
| 179 | return $old; | ||
| 180 | } else { | ||
| 181 | return $self->{_endpoint}; | ||
| 182 | } | ||
| 183 | } | ||
| 184 | |||
| 185 | sub session_id { | ||
| 186 | my $self = shift; | ||
| 187 | if( @_ ) { | ||
| 188 | my $old = $self->{_session_id}; | ||
| 189 | $self->{_session_id} = shift @_; | ||
| 190 | return $old; | ||
| 191 | } else { | ||
| 192 | return $self->{_session_id}; | ||
| 193 | } | ||
| 194 | } | ||
| 195 | |||
| 196 | sub _manufacture_methods { | ||
| 197 | my $package_name = shift; | ||
| 198 | |||
| 199 | foreach my $method ( $package_name->_methods ) { | ||
| 200 | next if( $package_name->can( $method ) ); | ||
| 201 | my $code = qq{ | ||
| 202 | package $package_name; | ||
| 203 | sub $method { | ||
| 204 | my \$self = shift; | ||
| 205 | my \$args = shift || { }; | ||
| 206 | die __PACKAGE__ . "::$method: requires a single hashref argument" unless( 'HASH' eq ref(\$args) ); | ||
| 207 | |||
| 208 | if( 'login' eq "$method" ) { | ||
| 209 | return \$self->_call( "login" => \$args ); | ||
| 210 | } else { | ||
| 211 | die __PACKAGE__ . "::$method: Not logged in" unless( defined( \$self->session_id ) ); | ||
| 212 | return \$self->_call( "$method" => { session_id => \$self->session_id, %\$args } ); | ||
| 213 | } | ||
| 214 | |||
| 215 | } | ||
| 216 | }; | ||
| 217 | |||
| 218 | eval( $code ); | ||
| 219 | } | ||
| 220 | |||
| 221 | } | ||
| 222 | |||
| 223 | sub BEGIN { | ||
| 224 | VR::API::_manufacture_methods( __PACKAGE__ ); | ||
| 225 | } | ||
| 226 | |||
| 227 | 1; | ||
| 228 | |||
| 229 | __END__ |