├── tests
    └── .gitkeep
├── .gitignore
├── .travis.yml
├── src
    ├── config
    │   └── config.php
    └── Hugofirth
    │   └── Mailchimp
    │       ├── MailchimpServiceProvider.php
    │       ├── Facades
    │           └── MailchimpWrapper.php
    │       └── MailchimpWrapper.php
├── phpunit.xml
├── composer.json
└── README.md


/tests/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | composer.phar
3 | composer.lock
4 | .DS_Store


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | 
 3 | php: 
 4 |   - 5.3
 5 |   - 5.4
 6 |   - 5.5
 7 | 
 8 | before_script:
 9 |   - curl -s http://getcomposer.org/installer | php
10 |   - php composer.phar install --dev
11 | 
12 | script: phpunit


--------------------------------------------------------------------------------
/src/config/config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | return array(
 5 | 
 6 | 	/*
 7 | 	|--------------------------------------------------------------------------
 8 | 	| API Secret Key
 9 | 	|--------------------------------------------------------------------------
10 | 	|
11 | 	| The api secret key provided by Mailchimp. If you don't know your API key
12 | 	| you can find out how to get it here:
13 | 	| "http://kb.mailchimp.com/article/where-can-i-find-my-api-key/"
14 | 	|
15 | 	*/
16 | 
17 | 	'apikey' => 'your-key-here',
18 | 
19 | 
20 | );
21 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit backupGlobals="false"
 3 |          backupStaticAttributes="false"
 4 |          bootstrap="vendor/autoload.php"
 5 |          colors="true"
 6 |          convertErrorsToExceptions="true"
 7 |          convertNoticesToExceptions="true"
 8 |          convertWarningsToExceptions="true"
 9 |          processIsolation="false"
10 |          stopOnFailure="false"
11 |          syntaxCheck="false"
12 | >
13 |     <testsuites>
14 |         <testsuite name="Package Test Suite">
15 |             <directory suffix=".php">./tests/</directory>
16 |         </testsuite>
17 |     </testsuites>
18 | </phpunit>


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "hugofirth/mailchimp",
 3 |     "description": "Wrapper on the Mailchimp class provided by Mailchimp - with support for Laravel 4. v2.0.0 supports Mailchimp API verion 2.0",
 4 |     "keywords": ["laravel", "mailchimp"],
 5 |     "license": "MIT",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Hugo Firth",
 9 |             "email": "hebfirth@gmail.com"
10 |         }
11 |     ],
12 |     "require": {
13 |         "php": ">=5.3.0",
14 |         "illuminate/support": "4.*|5.0.*",
15 |         "mailchimp/mailchimp": "2.0.*"
16 |     },
17 |     "autoload": {
18 |         "psr-0": {
19 |             "Hugofirth\\Mailchimp": "src/"
20 |         }
21 |     },
22 |     "extra": {
23 |         "branch-alias": {
24 |             "dev-master": "2.0-dev"
25 |         }
26 |     },
27 |     "minimum-stability": "dev"
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Hugofirth/Mailchimp/MailchimpServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php namespace Hugofirth\Mailchimp;
 2 | 
 3 | use Illuminate\Support\ServiceProvider;
 4 | use Illuminate\Support\Facades\Config;
 5 | use Mailchimp;
 6 | 
 7 | class MailchimpServiceProvider extends ServiceProvider {
 8 | 
 9 | 	/**
10 | 	 * Indicates if loading of the provider is deferred.
11 | 	 *
12 | 	 * @var bool
13 | 	 */
14 | 	protected $defer = false;
15 | 
16 | 	/**
17 | 	 * Bootstrap the application events.
18 | 	 *
19 | 	 * @return void
20 | 	 */
21 | 	public function boot()
22 | 	{
23 | 		$this->package('hugofirth/mailchimp');
24 | 	}
25 | 
26 | 	/**
27 | 	 * Register the service provider.
28 | 	 *
29 | 	 * @return void
30 | 	 */
31 | 	public function register()
32 | 	{
33 | 		$this->app->singleton('mailchimp_wrapper',  function() {
34 | 			$mc = new Mailchimp(Config::get('mailchimp::apikey'));
35 | 
36 | 			return new MailchimpWrapper($mc);
37 | 		});
38 | 	}
39 | 
40 | 	/**
41 | 	 * Get the services provided by the provider.
42 | 	 *
43 | 	 * @return array
44 | 	 */
45 | 	public function provides()
46 | 	{
47 | 		return array('mailchimp_wrapper');
48 | 	}
49 | 
50 | }
51 | 


--------------------------------------------------------------------------------
/src/Hugofirth/Mailchimp/Facades/MailchimpWrapper.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Hugofirth\Mailchimp\Facades;
 4 | 
 5 | use Illuminate\Support\Facades\Facade;
 6 | 
 7 | /**
 8 |  * Class MailchimpWrapper
 9 |  * Valid method/property list as of version Mailchimp API 2.0.4
10 |  * @method static \Mailchimp_Folders folders() accesses the $folders property
11 |  * @method static \Mailchimp_Templates templates() accesses the $templates property
12 |  * @method static \Mailchimp_Users users() accesses the $users property
13 |  * @method static \Mailchimp_Helper helper() accesses the $helper property
14 |  * @method static \Mailchimp_Mobile mobile() accesses the $mobile property
15 |  * @method static \Mailchimp_Ecomm ecomm() accesses the $ecomm property
16 |  * @method static \Mailchimp_Neapolitan neapolitan() accesses the $neapolitan property
17 |  * @method static \Mailchimp_Lists lists() accesses the $lists property
18 |  * @method static \Mailchimp_Campaigns campaigns() accesses the $campaigns property
19 |  * @method static \Mailchimp_Vip vip() accesses the $vip property
20 |  * @method static \Mailchimp_Reports reports() accesses the $reports property
21 |  * @method static \Mailchimp_Gallery gallery() accesses the $gallery property
22 |  * @method static bool ssl_verifypeer() accesses the $ssl_verifypeer property
23 |  * @method static bool ssl_verifyhost() accesses the $ssl_verifyhost property
24 |  * @method static string ssl_cainfo() accesses the $ssl_cainfo property
25 |  * @method static string apikey() accesses the $apikey property
26 |  * @method static bool debug() accesses the $debug property
27 |  * @method static array call($url, $params) accesses the call method
28 |  * @method static mixed readConfigs() accesses the readConfigs method
29 |  * @method static mixed caseError($result) accesses the castError method
30 |  * @method static void log($msg) accesses the log method
31 |  */
32 | class MailchimpWrapper extends Facade
33 | {
34 | 	protected static function getFacadeAccessor()
35 | 	{
36 | 		return 'mailchimp_wrapper';
37 | 	}
38 | }
39 | 


--------------------------------------------------------------------------------
/src/Hugofirth/Mailchimp/MailchimpWrapper.php:
--------------------------------------------------------------------------------
 1 | <?php namespace Hugofirth\Mailchimp;
 2 | 
 3 | use Mailchimp;
 4 | 
 5 | /**
 6 |  * Class MailchimpWrapper
 7 |  * Valid method/property list as of version Mailchimp API 2.0.4
 8 |  * @method \Mailchimp_Folders folders() accesses the $folders property
 9 |  * @method \Mailchimp_Templates templates() accesses the $templates property
10 |  * @method \Mailchimp_Users users() accesses the $users property
11 |  * @method \Mailchimp_Helper helper() accesses the $helper property
12 |  * @method \Mailchimp_Mobile mobile() accesses the $mobile property
13 |  * @method \Mailchimp_Ecomm ecomm() accesses the $ecomm property
14 |  * @method \Mailchimp_Neapolitan neapolitan() accesses the $neapolitan property
15 |  * @method \Mailchimp_Lists lists() accesses the $lists property
16 |  * @method \Mailchimp_Campaigns campaigns() accesses the $campaigns property
17 |  * @method \Mailchimp_Vip vip() accesses the $vip property
18 |  * @method \Mailchimp_Reports reports() accesses the $reports property
19 |  * @method \Mailchimp_Gallery gallery() accesses the $gallery property
20 |  * @method bool ssl_verifypeer() accesses the $ssl_verifypeer property
21 |  * @method bool ssl_verifyhost() accesses the $ssl_verifyhost property
22 |  * @method string ssl_cainfo() accesses the $ssl_cainfo property
23 |  * @method string apikey() accesses the $apikey property
24 |  * @method bool debug() accesses the $debug property
25 |  * @method array call($url, $params) accesses the call method
26 |  * @method mixed readConfigs() accesses the readConfigs method
27 |  * @method mixed caseError($result) accesses the castError method
28 |  * @method void log($msg) accesses the log method
29 |  */
30 | class MailchimpWrapper {
31 | 
32 | 	/**
33 | 	 * Field is instance of class Mailchimp
34 | 	 *
35 | 	 * @var mc
36 | 	 */
37 | 	protected $mc;
38 | 
39 | 	/**
40 | 	 * Constructor
41 | 	 *
42 | 	 * @param Mailchimp $mc
43 | 	 * @return void
44 | 	 */
45 | 	public function __construct(Mailchimp $mc)
46 | 	{
47 | 		$this->mc = $mc;
48 | 	}
49 | 
50 | 	/**
51 | 	 * Proxies call to the underlying MailChimp API
52 | 	 *
53 | 	 * @param $method
54 | 	 * @param array $args
55 | 	 * @return mixed
56 | 	 */
57 | 	public function __call($method, array $args)
58 | 	{
59 | 		//If it's a method, call it
60 | 		if(method_exists($this->mc, $method))
61 | 		{
62 | 			return call_user_func_array(array($this->mc, $method), $args);
63 | 		}
64 | 
65 | 		//Otherwise, treat it as a property
66 | 		return $this->mc->{$method};
67 | 	}
68 | 
69 | }
70 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Mailchimp API w. support for Laravel
 2 | ---
 3 | 
 4 | The package supports use with the [Laravel framework][2] (v4) providing a `MailchimpWrapper` facade. 
 5 | 
 6 | ----
 7 | 
 8 | ###Setup:
 9 | 
10 | In order to install add the following to your `composer.json` file within the `require` block:
11 | 
12 | ```js
13 | "require": {
14 |     …
15 |     "hugofirth/mailchimp": "2.0.*",
16 |     …
17 | }
18 | ```
19 | 
20 | Within Laravel, locate the file `..app/config/app.php` *.
21 | 
22 | Add the following to the `providers` array:
23 | 
24 | ```php
25 | 'providers' => array(
26 |     …
27 |     'Hugofirth\Mailchimp\MailchimpServiceProvider',
28 |     …
29 | ),
30 | ```
31 | 
32 | Furthermore, add the following the the `aliases` array:
33 | 
34 | ```php
35 | 'aliases' => array(
36 |     …
37 |     'MailchimpWrapper'       => 'Hugofirth\Mailchimp\Facades\MailchimpWrapper',
38 |     …
39 | ),
40 | ```
41 | 
42 | Publish the configuration
43 | 
44 | ```sh
45 | $ php artisan config:publish hugofirth/mailchimp
46 | ```
47 | 
48 | Lastly, run the command `composer update`.
49 | 
50 | _\* The subsequent steps should be repeated for any file `app.php` created for additional environments._ 
51 | 
52 | ----
53 | 
54 | ###Usage:
55 | 
56 | Your unique MailChimp API key should be set in the package's config found in `app/config/packages/hugofirth/mailchimp/config.php`
57 | 
58 | Methods of the MailChimp api class work as described by the MailChimp API docs found [Here][3]. Examples of actual usage can be found [Here][4] (**Warning**: Examples use CakePHP). Thanks to Laravel's use of the "Facade" design pattern, all methods may be called in the following manner:
59 | 
60 | ```php
61 | …
62 | //Retrieve an array of lists for your account
63 | $lists = MailchimpWrapper::lists()->getList()['data'];
64 | …
65 | //Subscribe a user, with email: $email_address, to a list with id: $list_id
66 | MailchimpWrapper::lists()->subscribe($list_id, array('email'=>$email_address));
67 | ```
68 | 
69 | In order to allow for auto-completion, you can include a use statement for the Facade:
70 | 
71 | ```php
72 | <?php
73 | 
74 | use Hugofirth\Mailchimp\Facades\MailchimpWrapper;
75 | 
76 | class SomeClass
77 | {
78 |     public function someMethod()
79 |     {
80 |         MailchimpWrapper:: //You should be able to get auto completion here for the API methods/properties
81 |     }
82 | }
83 | ```
84 | 
85 | Enjoy!
86 | 
87 | [1]: http://apidocs.mailchimp.com/api/downloads/#php
88 | [2]: http://laravel.com/
89 | [3]: http://apidocs.mailchimp.com/api/1.3/
90 | [4]: https://github.com/mailchimp/mcapi2-php-examples
91 | 


--------------------------------------------------------------------------------